diff --git a/.mock/definition/accounting/__package__.yml b/.mock/definition/accounting/__package__.yml index 3a198d77..4fa92c7a 100644 --- a/.mock/definition/accounting/__package__.yml +++ b/.mock/definition/accounting/__package__.yml @@ -1741,1569 +1741,2551 @@ types: source: openapi: openapi/openapi.yml inline: true - AccountRequestCurrency: - discriminated: false + AccountRequest: docs: >- - The account's currency. - - - * `XUA` - ADB Unit of Account - - * `AFN` - Afghan Afghani - - * `AFA` - Afghan Afghani (1927–2002) - - * `ALL` - Albanian Lek - - * `ALK` - Albanian Lek (1946–1965) - - * `DZD` - Algerian Dinar - - * `ADP` - Andorran Peseta - - * `AOA` - Angolan Kwanza - - * `AOK` - Angolan Kwanza (1977–1991) - - * `AON` - Angolan New Kwanza (1990–2000) - - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - - * `ARA` - Argentine Austral - - * `ARS` - Argentine Peso - - * `ARM` - Argentine Peso (1881–1970) - - * `ARP` - Argentine Peso (1983–1985) - - * `ARL` - Argentine Peso Ley (1970–1983) - - * `AMD` - Armenian Dram - - * `AWG` - Aruban Florin - - * `AUD` - Australian Dollar - - * `ATS` - Austrian Schilling - - * `AZN` - Azerbaijani Manat - - * `AZM` - Azerbaijani Manat (1993–2006) - - * `BSD` - Bahamian Dollar - - * `BHD` - Bahraini Dinar - - * `BDT` - Bangladeshi Taka - - * `BBD` - Barbadian Dollar - - * `BYN` - Belarusian Ruble - - * `BYB` - Belarusian Ruble (1994–1999) - - * `BYR` - Belarusian Ruble (2000–2016) - - * `BEF` - Belgian Franc - - * `BEC` - Belgian Franc (convertible) - - * `BEL` - Belgian Franc (financial) - - * `BZD` - Belize Dollar - - * `BMD` - Bermudan Dollar - - * `BTN` - Bhutanese Ngultrum - - * `BOB` - Bolivian Boliviano - - * `BOL` - Bolivian Boliviano (1863–1963) - - * `BOV` - Bolivian Mvdol - - * `BOP` - Bolivian Peso - - * `BAM` - Bosnia-Herzegovina Convertible Mark - - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - - * `BWP` - Botswanan Pula - - * `BRC` - Brazilian Cruzado (1986–1989) - - * `BRZ` - Brazilian Cruzeiro (1942–1967) - - * `BRE` - Brazilian Cruzeiro (1990–1993) - - * `BRR` - Brazilian Cruzeiro (1993–1994) - - * `BRN` - Brazilian New Cruzado (1989–1990) - - * `BRB` - Brazilian New Cruzeiro (1967–1986) - - * `BRL` - Brazilian Real - - * `GBP` - British Pound - - * `BND` - Brunei Dollar - - * `BGL` - Bulgarian Hard Lev - - * `BGN` - Bulgarian Lev - - * `BGO` - Bulgarian Lev (1879–1952) - - * `BGM` - Bulgarian Socialist Lev - - * `BUK` - Burmese Kyat - - * `BIF` - Burundian Franc - - * `XPF` - CFP Franc - - * `KHR` - Cambodian Riel - - * `CAD` - Canadian Dollar - - * `CVE` - Cape Verdean Escudo - - * `KYD` - Cayman Islands Dollar + # The Account Object - * `XAF` - Central African CFA Franc + ### Description - * `CLE` - Chilean Escudo + An `Account` represents a category in a company’s ledger in which a + financial transaction is recorded against. The aggregation of each + `Account` object is often referred to as the **Chart of Accounts**. - * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) + An `Account` can be classified into one of the following categories, + determined through the `classification` field: - * `CNX` - Chinese People’s Bank Dollar + * __Asset:__ Accounts Receivable and Bank Accounts - * `CNY` - Chinese Yuan + * __Liability:__ Accounts Payable and Credit Card Accounts - * `CNH` - Chinese Yuan (offshore) + * __Equity:__ Treasury Accounts and Retained Earnings - * `COP` - Colombian Peso + * __Revenue:__ Income and Other Income - * `COU` - Colombian Real Value Unit + * __Expense:__ Cost of Goods Sold and Office Expenses - * `KMF` - Comorian Franc - * `CDF` - Congolese Franc + ### Usage Example - * `CRC` - Costa Rican Colón + Fetch from the `LIST Accounts` endpoint and view a company's accounts. + properties: + name: + type: optional + docs: The account's name. + description: + type: optional + docs: The account's description. + classification: + type: optional + docs: |- + The account's broadest grouping. - * `HRD` - Croatian Dinar + * `ASSET` - ASSET + * `EQUITY` - EQUITY + * `EXPENSE` - EXPENSE + * `LIABILITY` - LIABILITY + * `REVENUE` - REVENUE + type: + type: optional + docs: >- + The account's type is a narrower and more specific grouping within the + account's classification. + account_type: + type: optional + docs: >- + Normalized account type- which is a narrower and more specific + grouping within the account's classification. - * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso + * `BANK` - BANK - * `CUP` - Cuban Peso + * `CREDIT_CARD` - CREDIT_CARD - * `CYP` - Cypriot Pound + * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE - * `CZK` - Czech Koruna + * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE - * `CSK` - Czechoslovak Hard Koruna + * `FIXED_ASSET` - FIXED_ASSET - * `DKK` - Danish Krone + * `OTHER_ASSET` - OTHER_ASSET - * `DJF` - Djiboutian Franc + * `OTHER_CURRENT_ASSET` - OTHER_CURRENT_ASSET - * `DOP` - Dominican Peso + * `OTHER_EXPENSE` - OTHER_EXPENSE - * `NLG` - Dutch Guilder + * `OTHER_INCOME` - OTHER_INCOME - * `XCD` - East Caribbean Dollar + * `COST_OF_GOODS_SOLD` - COST_OF_GOODS_SOLD - * `DDM` - East German Mark + * `OTHER_CURRENT_LIABILITY` - OTHER_CURRENT_LIABILITY - * `ECS` - Ecuadorian Sucre + * `LONG_TERM_LIABILITY` - LONG_TERM_LIABILITY - * `ECV` - Ecuadorian Unit of Constant Value + * `NON_POSTING` - NON_POSTING + status: + type: optional + docs: |- + The account's status. - * `EGP` - Egyptian Pound + * `ACTIVE` - ACTIVE + * `PENDING` - PENDING + * `INACTIVE` - INACTIVE + current_balance: + type: optional + docs: The account's current balance. + currency: optional + account_number: + type: optional + docs: The account's number. + parent_account: + type: optional + docs: ID of the parent account. + validation: + format: uuid + company: + type: optional + docs: The company the account belongs to. + validation: + format: uuid + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + AccountResponse: + properties: + model: Account + warnings: list + errors: list + logs: optional> + source: + openapi: openapi/openapi.yml + AccountStatusEnum: + enum: + - ACTIVE + - PENDING + - INACTIVE + docs: |- + * `ACTIVE` - ACTIVE + * `PENDING` - PENDING + * `INACTIVE` - INACTIVE + source: + openapi: openapi/openapi.yml + AccountToken: + properties: + account_token: string + integration: AccountIntegration + id: string + source: + openapi: openapi/openapi.yml + AccountingAttachment: + docs: >- + # The Accounting Attachment Object - * `GQE` - Equatorial Guinean Ekwele + ### Description - * `ERN` - Eritrean Nakfa + The `AccountingAttachment` object is used to represent a company's + attachments. - * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr + ### Usage Example - * `EUR` - Euro + Fetch from the `LIST AccountingAttachments` endpoint and view a company's + attachments. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + file_name: + type: optional + docs: The attachment's name. + file_url: + type: optional + docs: The attachment's url. + validation: + format: uri + maxLength: 2000 + company: + type: optional + docs: The company the accounting attachment belongs to. + validation: + format: uuid + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + AccountingAttachmentRequest: + docs: >- + # The Accounting Attachment Object - * `XBA` - European Composite Unit + ### Description - * `XEU` - European Currency Unit + The `AccountingAttachment` object is used to represent a company's + attachments. - * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) + ### Usage Example - * `XBD` - European Unit of Account (XBD) + Fetch from the `LIST AccountingAttachments` endpoint and view a company's + attachments. + properties: + file_name: + type: optional + docs: The attachment's name. + file_url: + type: optional + docs: The attachment's url. + validation: + format: uri + maxLength: 2000 + company: + type: optional + docs: The company the accounting attachment belongs to. + validation: + format: uuid + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + AccountingAttachmentResponse: + properties: + model: AccountingAttachment + warnings: list + errors: list + logs: optional> + source: + openapi: openapi/openapi.yml + AccountingPeriodStatus: + discriminated: false + union: + - Status895Enum + - string + source: + openapi: openapi/openapi.yml + inline: true + AccountingPeriod: + docs: >- + # The AccountingPeriod Object - * `FKP` - Falkland Islands Pound + ### Description - * `FJD` - Fijian Dollar + The `AccountingPeriod` object is used to define a period of time in which + events occurred. - * `FIM` - Finnish Markka - * `FRF` - French Franc + ### Usage Example - * `XFO` - French Gold Franc + Common models like `Invoice` and `Transaction` will have + `AccountingPeriod` objects which will denote when they occurred. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + name: + type: optional + docs: Name of the accounting period. + validation: + maxLength: 100 + status: optional + start_date: + type: optional + docs: Beginning date of the period + end_date: + type: optional + docs: End date of the period + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + AccountingPhoneNumber: + docs: >- + # The AccountingPhoneNumber Object - * `XFU` - French UIC-Franc + ### Description - * `GMD` - Gambian Dalasi + The `AccountingPhoneNumber` object is used to represent a contact's or + company's phone number. - * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari + ### Usage Example - * `DEM` - German Mark + Fetch from the `GET CompanyInfo` endpoint and view the company's phone + numbers. + properties: + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + number: + type: optional + docs: The phone number. + type: + type: optional + docs: The phone number's type. + source: + openapi: openapi/openapi.yml + AccountingPhoneNumberRequest: + docs: >- + # The AccountingPhoneNumber Object - * `GHS` - Ghanaian Cedi + ### Description - * `GHC` - Ghanaian Cedi (1979–2007) + The `AccountingPhoneNumber` object is used to represent a contact's or + company's phone number. - * `GIP` - Gibraltar Pound - * `XAU` - Gold + ### Usage Example - * `GRD` - Greek Drachma + Fetch from the `GET CompanyInfo` endpoint and view the company's phone + numbers. + properties: + number: + type: optional + docs: The phone number. + type: + type: optional + docs: The phone number's type. + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + AddressType: + discriminated: false + docs: |- + The address type. - * `GTQ` - Guatemalan Quetzal + * `BILLING` - BILLING + * `SHIPPING` - SHIPPING + union: + - AddressTypeEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + AddressCountry: + discriminated: false + docs: |- + The address's country. - * `GWP` - Guinea-Bissau Peso - - * `GNF` - Guinean Franc - - * `GNS` - Guinean Syli - - * `GYD` - Guyanaese Dollar - - * `HTG` - Haitian Gourde - - * `HNL` - Honduran Lempira - - * `HKD` - Hong Kong Dollar - - * `HUF` - Hungarian Forint - - * `IMP` - IMP - - * `ISK` - Icelandic Króna - - * `ISJ` - Icelandic Króna (1918–1981) - - * `INR` - Indian Rupee - - * `IDR` - Indonesian Rupiah - - * `IRR` - Iranian Rial - - * `IQD` - Iraqi Dinar - - * `IEP` - Irish Pound - - * `ILS` - Israeli New Shekel - - * `ILP` - Israeli Pound - - * `ILR` - Israeli Shekel (1980–1985) - - * `ITL` - Italian Lira - - * `JMD` - Jamaican Dollar - - * `JPY` - Japanese Yen - - * `JOD` - Jordanian Dinar - - * `KZT` - Kazakhstani Tenge - - * `KES` - Kenyan Shilling - - * `KWD` - Kuwaiti Dinar - - * `KGS` - Kyrgystani Som - - * `LAK` - Laotian Kip - - * `LVL` - Latvian Lats - - * `LVR` - Latvian Ruble - - * `LBP` - Lebanese Pound - - * `LSL` - Lesotho Loti - - * `LRD` - Liberian Dollar - - * `LYD` - Libyan Dinar - - * `LTL` - Lithuanian Litas - - * `LTT` - Lithuanian Talonas - - * `LUL` - Luxembourg Financial Franc - - * `LUC` - Luxembourgian Convertible Franc - - * `LUF` - Luxembourgian Franc - - * `MOP` - Macanese Pataca - - * `MKD` - Macedonian Denar - - * `MKN` - Macedonian Denar (1992–1993) - - * `MGA` - Malagasy Ariary - - * `MGF` - Malagasy Franc - - * `MWK` - Malawian Kwacha - - * `MYR` - Malaysian Ringgit - - * `MVR` - Maldivian Rufiyaa - - * `MVP` - Maldivian Rupee (1947–1981) - - * `MLF` - Malian Franc - - * `MTL` - Maltese Lira - - * `MTP` - Maltese Pound - - * `MRU` - Mauritanian Ouguiya - - * `MRO` - Mauritanian Ouguiya (1973–2017) - - * `MUR` - Mauritian Rupee - - * `MXV` - Mexican Investment Unit - - * `MXN` - Mexican Peso - - * `MXP` - Mexican Silver Peso (1861–1992) - - * `MDC` - Moldovan Cupon - - * `MDL` - Moldovan Leu - - * `MCF` - Monegasque Franc - - * `MNT` - Mongolian Tugrik - - * `MAD` - Moroccan Dirham - - * `MAF` - Moroccan Franc - - * `MZE` - Mozambican Escudo - - * `MZN` - Mozambican Metical - - * `MZM` - Mozambican Metical (1980–2006) - - * `MMK` - Myanmar Kyat - - * `NAD` - Namibian Dollar - - * `NPR` - Nepalese Rupee - - * `ANG` - Netherlands Antillean Guilder - - * `TWD` - New Taiwan Dollar - - * `NZD` - New Zealand Dollar - - * `NIO` - Nicaraguan Córdoba - - * `NIC` - Nicaraguan Córdoba (1988–1991) - - * `NGN` - Nigerian Naira - - * `KPW` - North Korean Won - - * `NOK` - Norwegian Krone - - * `OMR` - Omani Rial - - * `PKR` - Pakistani Rupee - - * `XPD` - Palladium - - * `PAB` - Panamanian Balboa - - * `PGK` - Papua New Guinean Kina - - * `PYG` - Paraguayan Guarani - - * `PEI` - Peruvian Inti - - * `PEN` - Peruvian Sol - - * `PES` - Peruvian Sol (1863–1965) - - * `PHP` - Philippine Peso - - * `XPT` - Platinum - - * `PLN` - Polish Zloty - - * `PLZ` - Polish Zloty (1950–1995) - - * `PTE` - Portuguese Escudo - - * `GWE` - Portuguese Guinea Escudo - - * `QAR` - Qatari Rial - - * `XRE` - RINET Funds - - * `RHD` - Rhodesian Dollar - - * `RON` - Romanian Leu - - * `ROL` - Romanian Leu (1952–2006) - - * `RUB` - Russian Ruble - - * `RUR` - Russian Ruble (1991–1998) - - * `RWF` - Rwandan Franc - - * `SVC` - Salvadoran Colón - - * `WST` - Samoan Tala - - * `SAR` - Saudi Riyal - - * `RSD` - Serbian Dinar - - * `CSD` - Serbian Dinar (2002–2006) + * `AF` - Afghanistan + * `AX` - Åland Islands + * `AL` - Albania + * `DZ` - Algeria + * `AS` - American Samoa + * `AD` - Andorra + * `AO` - Angola + * `AI` - Anguilla + * `AQ` - Antarctica + * `AG` - Antigua and Barbuda + * `AR` - Argentina + * `AM` - Armenia + * `AW` - Aruba + * `AU` - Australia + * `AT` - Austria + * `AZ` - Azerbaijan + * `BS` - Bahamas + * `BH` - Bahrain + * `BD` - Bangladesh + * `BB` - Barbados + * `BY` - Belarus + * `BE` - Belgium + * `BZ` - Belize + * `BJ` - Benin + * `BM` - Bermuda + * `BT` - Bhutan + * `BO` - Bolivia + * `BQ` - Bonaire, Sint Eustatius and Saba + * `BA` - Bosnia and Herzegovina + * `BW` - Botswana + * `BV` - Bouvet Island + * `BR` - Brazil + * `IO` - British Indian Ocean Territory + * `BN` - Brunei + * `BG` - Bulgaria + * `BF` - Burkina Faso + * `BI` - Burundi + * `CV` - Cabo Verde + * `KH` - Cambodia + * `CM` - Cameroon + * `CA` - Canada + * `KY` - Cayman Islands + * `CF` - Central African Republic + * `TD` - Chad + * `CL` - Chile + * `CN` - China + * `CX` - Christmas Island + * `CC` - Cocos (Keeling) Islands + * `CO` - Colombia + * `KM` - Comoros + * `CG` - Congo + * `CD` - Congo (the Democratic Republic of the) + * `CK` - Cook Islands + * `CR` - Costa Rica + * `CI` - Côte d'Ivoire + * `HR` - Croatia + * `CU` - Cuba + * `CW` - Curaçao + * `CY` - Cyprus + * `CZ` - Czechia + * `DK` - Denmark + * `DJ` - Djibouti + * `DM` - Dominica + * `DO` - Dominican Republic + * `EC` - Ecuador + * `EG` - Egypt + * `SV` - El Salvador + * `GQ` - Equatorial Guinea + * `ER` - Eritrea + * `EE` - Estonia + * `SZ` - Eswatini + * `ET` - Ethiopia + * `FK` - Falkland Islands (Malvinas) + * `FO` - Faroe Islands + * `FJ` - Fiji + * `FI` - Finland + * `FR` - France + * `GF` - French Guiana + * `PF` - French Polynesia + * `TF` - French Southern Territories + * `GA` - Gabon + * `GM` - Gambia + * `GE` - Georgia + * `DE` - Germany + * `GH` - Ghana + * `GI` - Gibraltar + * `GR` - Greece + * `GL` - Greenland + * `GD` - Grenada + * `GP` - Guadeloupe + * `GU` - Guam + * `GT` - Guatemala + * `GG` - Guernsey + * `GN` - Guinea + * `GW` - Guinea-Bissau + * `GY` - Guyana + * `HT` - Haiti + * `HM` - Heard Island and McDonald Islands + * `VA` - Holy See + * `HN` - Honduras + * `HK` - Hong Kong + * `HU` - Hungary + * `IS` - Iceland + * `IN` - India + * `ID` - Indonesia + * `IR` - Iran + * `IQ` - Iraq + * `IE` - Ireland + * `IM` - Isle of Man + * `IL` - Israel + * `IT` - Italy + * `JM` - Jamaica + * `JP` - Japan + * `JE` - Jersey + * `JO` - Jordan + * `KZ` - Kazakhstan + * `KE` - Kenya + * `KI` - Kiribati + * `KW` - Kuwait + * `KG` - Kyrgyzstan + * `LA` - Laos + * `LV` - Latvia + * `LB` - Lebanon + * `LS` - Lesotho + * `LR` - Liberia + * `LY` - Libya + * `LI` - Liechtenstein + * `LT` - Lithuania + * `LU` - Luxembourg + * `MO` - Macao + * `MG` - Madagascar + * `MW` - Malawi + * `MY` - Malaysia + * `MV` - Maldives + * `ML` - Mali + * `MT` - Malta + * `MH` - Marshall Islands + * `MQ` - Martinique + * `MR` - Mauritania + * `MU` - Mauritius + * `YT` - Mayotte + * `MX` - Mexico + * `FM` - Micronesia (Federated States of) + * `MD` - Moldova + * `MC` - Monaco + * `MN` - Mongolia + * `ME` - Montenegro + * `MS` - Montserrat + * `MA` - Morocco + * `MZ` - Mozambique + * `MM` - Myanmar + * `NA` - Namibia + * `NR` - Nauru + * `NP` - Nepal + * `NL` - Netherlands + * `NC` - New Caledonia + * `NZ` - New Zealand + * `NI` - Nicaragua + * `NE` - Niger + * `NG` - Nigeria + * `NU` - Niue + * `NF` - Norfolk Island + * `KP` - North Korea + * `MK` - North Macedonia + * `MP` - Northern Mariana Islands + * `NO` - Norway + * `OM` - Oman + * `PK` - Pakistan + * `PW` - Palau + * `PS` - Palestine, State of + * `PA` - Panama + * `PG` - Papua New Guinea + * `PY` - Paraguay + * `PE` - Peru + * `PH` - Philippines + * `PN` - Pitcairn + * `PL` - Poland + * `PT` - Portugal + * `PR` - Puerto Rico + * `QA` - Qatar + * `RE` - Réunion + * `RO` - Romania + * `RU` - Russia + * `RW` - Rwanda + * `BL` - Saint Barthélemy + * `SH` - Saint Helena, Ascension and Tristan da Cunha + * `KN` - Saint Kitts and Nevis + * `LC` - Saint Lucia + * `MF` - Saint Martin (French part) + * `PM` - Saint Pierre and Miquelon + * `VC` - Saint Vincent and the Grenadines + * `WS` - Samoa + * `SM` - San Marino + * `ST` - Sao Tome and Principe + * `SA` - Saudi Arabia + * `SN` - Senegal + * `RS` - Serbia + * `SC` - Seychelles + * `SL` - Sierra Leone + * `SG` - Singapore + * `SX` - Sint Maarten (Dutch part) + * `SK` - Slovakia + * `SI` - Slovenia + * `SB` - Solomon Islands + * `SO` - Somalia + * `ZA` - South Africa + * `GS` - South Georgia and the South Sandwich Islands + * `KR` - South Korea + * `SS` - South Sudan + * `ES` - Spain + * `LK` - Sri Lanka + * `SD` - Sudan + * `SR` - Suriname + * `SJ` - Svalbard and Jan Mayen + * `SE` - Sweden + * `CH` - Switzerland + * `SY` - Syria + * `TW` - Taiwan + * `TJ` - Tajikistan + * `TZ` - Tanzania + * `TH` - Thailand + * `TL` - Timor-Leste + * `TG` - Togo + * `TK` - Tokelau + * `TO` - Tonga + * `TT` - Trinidad and Tobago + * `TN` - Tunisia + * `TR` - Turkey + * `TM` - Turkmenistan + * `TC` - Turks and Caicos Islands + * `TV` - Tuvalu + * `UG` - Uganda + * `UA` - Ukraine + * `AE` - United Arab Emirates + * `GB` - United Kingdom + * `UM` - United States Minor Outlying Islands + * `US` - United States of America + * `UY` - Uruguay + * `UZ` - Uzbekistan + * `VU` - Vanuatu + * `VE` - Venezuela + * `VN` - Vietnam + * `VG` - Virgin Islands (British) + * `VI` - Virgin Islands (U.S.) + * `WF` - Wallis and Futuna + * `EH` - Western Sahara + * `YE` - Yemen + * `ZM` - Zambia + * `ZW` - Zimbabwe + union: + - CountryEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + Address: + docs: >- + # The Address Object - * `SCR` - Seychellois Rupee + ### Description - * `SLL` - Sierra Leonean Leone + The `Address` object is used to represent a contact's or company's + address. - * `XAG` - Silver - * `SGD` - Singapore Dollar + ### Usage Example - * `SKK` - Slovak Koruna + Fetch from the `GET CompanyInfo` endpoint and view the company's + addresses. + properties: + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + type: + type: optional + docs: |- + The address type. - * `SIT` - Slovenian Tolar + * `BILLING` - BILLING + * `SHIPPING` - SHIPPING + street_1: + type: optional + docs: Line 1 of the address's street. + street_2: + type: optional + docs: Line 2 of the address's street. + city: + type: optional + docs: The address's city. + state: + type: optional + access: read-only + country_subdivision: + type: optional + docs: The address's state or region. + country: + type: optional + docs: |- + The address's country. - * `SBD` - Solomon Islands Dollar - - * `SOS` - Somali Shilling - - * `ZAR` - South African Rand - - * `ZAL` - South African Rand (financial) - - * `KRH` - South Korean Hwan (1953–1962) - - * `KRW` - South Korean Won - - * `KRO` - South Korean Won (1945–1953) - - * `SSP` - South Sudanese Pound - - * `SUR` - Soviet Rouble - - * `ESP` - Spanish Peseta - - * `ESA` - Spanish Peseta (A account) - - * `ESB` - Spanish Peseta (convertible account) - - * `XDR` - Special Drawing Rights - - * `LKR` - Sri Lankan Rupee - - * `SHP` - St. Helena Pound - - * `XSU` - Sucre - - * `SDD` - Sudanese Dinar (1992–2007) - - * `SDG` - Sudanese Pound - - * `SDP` - Sudanese Pound (1957–1998) - - * `SRD` - Surinamese Dollar - - * `SRG` - Surinamese Guilder - - * `SZL` - Swazi Lilangeni - - * `SEK` - Swedish Krona - - * `CHF` - Swiss Franc - - * `SYP` - Syrian Pound - - * `STN` - São Tomé & Príncipe Dobra - - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - - * `TVD` - TVD - - * `TJR` - Tajikistani Ruble - - * `TJS` - Tajikistani Somoni - - * `TZS` - Tanzanian Shilling - - * `XTS` - Testing Currency Code - - * `THB` - Thai Baht - - * `XXX` - The codes assigned for transactions where no currency is - involved - - * `TPE` - Timorese Escudo - - * `TOP` - Tongan Paʻanga - - * `TTD` - Trinidad & Tobago Dollar - - * `TND` - Tunisian Dinar - - * `TRY` - Turkish Lira - - * `TRL` - Turkish Lira (1922–2005) - - * `TMT` - Turkmenistani Manat - - * `TMM` - Turkmenistani Manat (1993–2009) - - * `USD` - US Dollar - - * `USN` - US Dollar (Next day) - - * `USS` - US Dollar (Same day) - - * `UGX` - Ugandan Shilling - - * `UGS` - Ugandan Shilling (1966–1987) - - * `UAH` - Ukrainian Hryvnia - - * `UAK` - Ukrainian Karbovanets - - * `AED` - United Arab Emirates Dirham - - * `UYW` - Uruguayan Nominal Wage Index Unit - - * `UYU` - Uruguayan Peso - - * `UYP` - Uruguayan Peso (1975–1993) - - * `UYI` - Uruguayan Peso (Indexed Units) - - * `UZS` - Uzbekistani Som - - * `VUV` - Vanuatu Vatu - - * `VES` - Venezuelan Bolívar - - * `VEB` - Venezuelan Bolívar (1871–2008) - - * `VEF` - Venezuelan Bolívar (2008–2018) - - * `VND` - Vietnamese Dong - - * `VNN` - Vietnamese Dong (1978–1985) - - * `CHE` - WIR Euro - - * `CHW` - WIR Franc - - * `XOF` - West African CFA Franc - - * `YDD` - Yemeni Dinar - - * `YER` - Yemeni Rial - - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - - * `YUM` - Yugoslavian New Dinar (1994–2002) - - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - - * `ZWN` - ZWN - - * `ZRN` - Zairean New Zaire (1993–1998) - - * `ZRZ` - Zairean Zaire (1971–1993) - - * `ZMW` - Zambian Kwacha - - * `ZMK` - Zambian Kwacha (1968–2012) - - * `ZWD` - Zimbabwean Dollar (1980–2008) - - * `ZWR` - Zimbabwean Dollar (2008) + * `AF` - Afghanistan + * `AX` - Åland Islands + * `AL` - Albania + * `DZ` - Algeria + * `AS` - American Samoa + * `AD` - Andorra + * `AO` - Angola + * `AI` - Anguilla + * `AQ` - Antarctica + * `AG` - Antigua and Barbuda + * `AR` - Argentina + * `AM` - Armenia + * `AW` - Aruba + * `AU` - Australia + * `AT` - Austria + * `AZ` - Azerbaijan + * `BS` - Bahamas + * `BH` - Bahrain + * `BD` - Bangladesh + * `BB` - Barbados + * `BY` - Belarus + * `BE` - Belgium + * `BZ` - Belize + * `BJ` - Benin + * `BM` - Bermuda + * `BT` - Bhutan + * `BO` - Bolivia + * `BQ` - Bonaire, Sint Eustatius and Saba + * `BA` - Bosnia and Herzegovina + * `BW` - Botswana + * `BV` - Bouvet Island + * `BR` - Brazil + * `IO` - British Indian Ocean Territory + * `BN` - Brunei + * `BG` - Bulgaria + * `BF` - Burkina Faso + * `BI` - Burundi + * `CV` - Cabo Verde + * `KH` - Cambodia + * `CM` - Cameroon + * `CA` - Canada + * `KY` - Cayman Islands + * `CF` - Central African Republic + * `TD` - Chad + * `CL` - Chile + * `CN` - China + * `CX` - Christmas Island + * `CC` - Cocos (Keeling) Islands + * `CO` - Colombia + * `KM` - Comoros + * `CG` - Congo + * `CD` - Congo (the Democratic Republic of the) + * `CK` - Cook Islands + * `CR` - Costa Rica + * `CI` - Côte d'Ivoire + * `HR` - Croatia + * `CU` - Cuba + * `CW` - Curaçao + * `CY` - Cyprus + * `CZ` - Czechia + * `DK` - Denmark + * `DJ` - Djibouti + * `DM` - Dominica + * `DO` - Dominican Republic + * `EC` - Ecuador + * `EG` - Egypt + * `SV` - El Salvador + * `GQ` - Equatorial Guinea + * `ER` - Eritrea + * `EE` - Estonia + * `SZ` - Eswatini + * `ET` - Ethiopia + * `FK` - Falkland Islands (Malvinas) + * `FO` - Faroe Islands + * `FJ` - Fiji + * `FI` - Finland + * `FR` - France + * `GF` - French Guiana + * `PF` - French Polynesia + * `TF` - French Southern Territories + * `GA` - Gabon + * `GM` - Gambia + * `GE` - Georgia + * `DE` - Germany + * `GH` - Ghana + * `GI` - Gibraltar + * `GR` - Greece + * `GL` - Greenland + * `GD` - Grenada + * `GP` - Guadeloupe + * `GU` - Guam + * `GT` - Guatemala + * `GG` - Guernsey + * `GN` - Guinea + * `GW` - Guinea-Bissau + * `GY` - Guyana + * `HT` - Haiti + * `HM` - Heard Island and McDonald Islands + * `VA` - Holy See + * `HN` - Honduras + * `HK` - Hong Kong + * `HU` - Hungary + * `IS` - Iceland + * `IN` - India + * `ID` - Indonesia + * `IR` - Iran + * `IQ` - Iraq + * `IE` - Ireland + * `IM` - Isle of Man + * `IL` - Israel + * `IT` - Italy + * `JM` - Jamaica + * `JP` - Japan + * `JE` - Jersey + * `JO` - Jordan + * `KZ` - Kazakhstan + * `KE` - Kenya + * `KI` - Kiribati + * `KW` - Kuwait + * `KG` - Kyrgyzstan + * `LA` - Laos + * `LV` - Latvia + * `LB` - Lebanon + * `LS` - Lesotho + * `LR` - Liberia + * `LY` - Libya + * `LI` - Liechtenstein + * `LT` - Lithuania + * `LU` - Luxembourg + * `MO` - Macao + * `MG` - Madagascar + * `MW` - Malawi + * `MY` - Malaysia + * `MV` - Maldives + * `ML` - Mali + * `MT` - Malta + * `MH` - Marshall Islands + * `MQ` - Martinique + * `MR` - Mauritania + * `MU` - Mauritius + * `YT` - Mayotte + * `MX` - Mexico + * `FM` - Micronesia (Federated States of) + * `MD` - Moldova + * `MC` - Monaco + * `MN` - Mongolia + * `ME` - Montenegro + * `MS` - Montserrat + * `MA` - Morocco + * `MZ` - Mozambique + * `MM` - Myanmar + * `NA` - Namibia + * `NR` - Nauru + * `NP` - Nepal + * `NL` - Netherlands + * `NC` - New Caledonia + * `NZ` - New Zealand + * `NI` - Nicaragua + * `NE` - Niger + * `NG` - Nigeria + * `NU` - Niue + * `NF` - Norfolk Island + * `KP` - North Korea + * `MK` - North Macedonia + * `MP` - Northern Mariana Islands + * `NO` - Norway + * `OM` - Oman + * `PK` - Pakistan + * `PW` - Palau + * `PS` - Palestine, State of + * `PA` - Panama + * `PG` - Papua New Guinea + * `PY` - Paraguay + * `PE` - Peru + * `PH` - Philippines + * `PN` - Pitcairn + * `PL` - Poland + * `PT` - Portugal + * `PR` - Puerto Rico + * `QA` - Qatar + * `RE` - Réunion + * `RO` - Romania + * `RU` - Russia + * `RW` - Rwanda + * `BL` - Saint Barthélemy + * `SH` - Saint Helena, Ascension and Tristan da Cunha + * `KN` - Saint Kitts and Nevis + * `LC` - Saint Lucia + * `MF` - Saint Martin (French part) + * `PM` - Saint Pierre and Miquelon + * `VC` - Saint Vincent and the Grenadines + * `WS` - Samoa + * `SM` - San Marino + * `ST` - Sao Tome and Principe + * `SA` - Saudi Arabia + * `SN` - Senegal + * `RS` - Serbia + * `SC` - Seychelles + * `SL` - Sierra Leone + * `SG` - Singapore + * `SX` - Sint Maarten (Dutch part) + * `SK` - Slovakia + * `SI` - Slovenia + * `SB` - Solomon Islands + * `SO` - Somalia + * `ZA` - South Africa + * `GS` - South Georgia and the South Sandwich Islands + * `KR` - South Korea + * `SS` - South Sudan + * `ES` - Spain + * `LK` - Sri Lanka + * `SD` - Sudan + * `SR` - Suriname + * `SJ` - Svalbard and Jan Mayen + * `SE` - Sweden + * `CH` - Switzerland + * `SY` - Syria + * `TW` - Taiwan + * `TJ` - Tajikistan + * `TZ` - Tanzania + * `TH` - Thailand + * `TL` - Timor-Leste + * `TG` - Togo + * `TK` - Tokelau + * `TO` - Tonga + * `TT` - Trinidad and Tobago + * `TN` - Tunisia + * `TR` - Turkey + * `TM` - Turkmenistan + * `TC` - Turks and Caicos Islands + * `TV` - Tuvalu + * `UG` - Uganda + * `UA` - Ukraine + * `AE` - United Arab Emirates + * `GB` - United Kingdom + * `UM` - United States Minor Outlying Islands + * `US` - United States of America + * `UY` - Uruguay + * `UZ` - Uzbekistan + * `VU` - Vanuatu + * `VE` - Venezuela + * `VN` - Vietnam + * `VG` - Virgin Islands (British) + * `VI` - Virgin Islands (U.S.) + * `WF` - Wallis and Futuna + * `EH` - Western Sahara + * `YE` - Yemen + * `ZM` - Zambia + * `ZW` - Zimbabwe + zip_code: + type: optional + docs: The address's zip code. + source: + openapi: openapi/openapi.yml + AddressRequestType: + discriminated: false + docs: |- + The address type. - * `ZWL` - Zimbabwean Dollar (2009) + * `BILLING` - BILLING + * `SHIPPING` - SHIPPING union: - - TransactionCurrencyEnum + - AddressTypeEnum - string source: openapi: openapi/openapi.yml inline: true - AccountRequest: - docs: >- - # The Account Object - - ### Description - - An `Account` represents a category in a company’s ledger in which a - financial transaction is recorded against. The aggregation of each - `Account` object is often referred to as the **Chart of Accounts**. - - - An `Account` can be classified into one of the following categories, - determined through the `classification` field: - - * __Asset:__ Accounts Receivable and Bank Accounts - - * __Liability:__ Accounts Payable and Credit Card Accounts - - * __Equity:__ Treasury Accounts and Retained Earnings - - * __Revenue:__ Income and Other Income - - * __Expense:__ Cost of Goods Sold and Office Expenses - - - ### Usage Example - - Fetch from the `LIST Accounts` endpoint and view a company's accounts. - properties: - name: - type: optional - docs: The account's name. - description: - type: optional - docs: The account's description. - classification: - type: optional - docs: |- - The account's broadest grouping. - - * `ASSET` - ASSET - * `EQUITY` - EQUITY - * `EXPENSE` - EXPENSE - * `LIABILITY` - LIABILITY - * `REVENUE` - REVENUE - type: - type: optional - docs: >- - The account's type is a narrower and more specific grouping within the - account's classification. - account_type: - type: optional - docs: >- - Normalized account type- which is a narrower and more specific - grouping within the account's classification. - - - * `BANK` - BANK - - * `CREDIT_CARD` - CREDIT_CARD - - * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE - - * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE - - * `FIXED_ASSET` - FIXED_ASSET - - * `OTHER_ASSET` - OTHER_ASSET - - * `OTHER_CURRENT_ASSET` - OTHER_CURRENT_ASSET - - * `OTHER_EXPENSE` - OTHER_EXPENSE - - * `OTHER_INCOME` - OTHER_INCOME - - * `COST_OF_GOODS_SOLD` - COST_OF_GOODS_SOLD - - * `OTHER_CURRENT_LIABILITY` - OTHER_CURRENT_LIABILITY - - * `LONG_TERM_LIABILITY` - LONG_TERM_LIABILITY - - * `NON_POSTING` - NON_POSTING - status: - type: optional - docs: |- - The account's status. + AddressRequestCountry: + discriminated: false + docs: |- + The address's country. - * `ACTIVE` - ACTIVE - * `PENDING` - PENDING - * `INACTIVE` - INACTIVE - current_balance: - type: optional - docs: The account's current balance. - currency: - type: optional - docs: >- - The account's currency. - - - * `XUA` - ADB Unit of Account - - * `AFN` - Afghan Afghani - - * `AFA` - Afghan Afghani (1927–2002) - - * `ALL` - Albanian Lek - - * `ALK` - Albanian Lek (1946–1965) - - * `DZD` - Algerian Dinar - - * `ADP` - Andorran Peseta - - * `AOA` - Angolan Kwanza - - * `AOK` - Angolan Kwanza (1977–1991) - - * `AON` - Angolan New Kwanza (1990–2000) - - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - - * `ARA` - Argentine Austral - - * `ARS` - Argentine Peso - - * `ARM` - Argentine Peso (1881–1970) - - * `ARP` - Argentine Peso (1983–1985) - - * `ARL` - Argentine Peso Ley (1970–1983) - - * `AMD` - Armenian Dram - - * `AWG` - Aruban Florin - - * `AUD` - Australian Dollar - - * `ATS` - Austrian Schilling - - * `AZN` - Azerbaijani Manat - - * `AZM` - Azerbaijani Manat (1993–2006) - - * `BSD` - Bahamian Dollar - - * `BHD` - Bahraini Dinar - - * `BDT` - Bangladeshi Taka - - * `BBD` - Barbadian Dollar - - * `BYN` - Belarusian Ruble - - * `BYB` - Belarusian Ruble (1994–1999) - - * `BYR` - Belarusian Ruble (2000–2016) - - * `BEF` - Belgian Franc - - * `BEC` - Belgian Franc (convertible) - - * `BEL` - Belgian Franc (financial) - - * `BZD` - Belize Dollar - - * `BMD` - Bermudan Dollar - - * `BTN` - Bhutanese Ngultrum - - * `BOB` - Bolivian Boliviano - - * `BOL` - Bolivian Boliviano (1863–1963) - - * `BOV` - Bolivian Mvdol - - * `BOP` - Bolivian Peso - - * `BAM` - Bosnia-Herzegovina Convertible Mark - - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - - * `BWP` - Botswanan Pula - - * `BRC` - Brazilian Cruzado (1986–1989) - - * `BRZ` - Brazilian Cruzeiro (1942–1967) - - * `BRE` - Brazilian Cruzeiro (1990–1993) - - * `BRR` - Brazilian Cruzeiro (1993–1994) - - * `BRN` - Brazilian New Cruzado (1989–1990) - - * `BRB` - Brazilian New Cruzeiro (1967–1986) - - * `BRL` - Brazilian Real - - * `GBP` - British Pound - - * `BND` - Brunei Dollar - - * `BGL` - Bulgarian Hard Lev - - * `BGN` - Bulgarian Lev - - * `BGO` - Bulgarian Lev (1879–1952) - - * `BGM` - Bulgarian Socialist Lev - - * `BUK` - Burmese Kyat - - * `BIF` - Burundian Franc - - * `XPF` - CFP Franc - - * `KHR` - Cambodian Riel - - * `CAD` - Canadian Dollar - - * `CVE` - Cape Verdean Escudo - - * `KYD` - Cayman Islands Dollar - - * `XAF` - Central African CFA Franc - - * `CLE` - Chilean Escudo - - * `CLP` - Chilean Peso - - * `CLF` - Chilean Unit of Account (UF) - - * `CNX` - Chinese People’s Bank Dollar - - * `CNY` - Chinese Yuan - - * `CNH` - Chinese Yuan (offshore) - - * `COP` - Colombian Peso - - * `COU` - Colombian Real Value Unit - - * `KMF` - Comorian Franc - - * `CDF` - Congolese Franc - - * `CRC` - Costa Rican Colón - - * `HRD` - Croatian Dinar - - * `HRK` - Croatian Kuna - - * `CUC` - Cuban Convertible Peso - - * `CUP` - Cuban Peso - - * `CYP` - Cypriot Pound - - * `CZK` - Czech Koruna - - * `CSK` - Czechoslovak Hard Koruna - - * `DKK` - Danish Krone - - * `DJF` - Djiboutian Franc - - * `DOP` - Dominican Peso - - * `NLG` - Dutch Guilder - - * `XCD` - East Caribbean Dollar - - * `DDM` - East German Mark - - * `ECS` - Ecuadorian Sucre - - * `ECV` - Ecuadorian Unit of Constant Value - - * `EGP` - Egyptian Pound - - * `GQE` - Equatorial Guinean Ekwele - - * `ERN` - Eritrean Nakfa - - * `EEK` - Estonian Kroon - - * `ETB` - Ethiopian Birr - - * `EUR` - Euro - - * `XBA` - European Composite Unit - - * `XEU` - European Currency Unit - - * `XBB` - European Monetary Unit - - * `XBC` - European Unit of Account (XBC) - - * `XBD` - European Unit of Account (XBD) - - * `FKP` - Falkland Islands Pound - - * `FJD` - Fijian Dollar - - * `FIM` - Finnish Markka - - * `FRF` - French Franc - - * `XFO` - French Gold Franc - - * `XFU` - French UIC-Franc + * `AF` - Afghanistan + * `AX` - Åland Islands + * `AL` - Albania + * `DZ` - Algeria + * `AS` - American Samoa + * `AD` - Andorra + * `AO` - Angola + * `AI` - Anguilla + * `AQ` - Antarctica + * `AG` - Antigua and Barbuda + * `AR` - Argentina + * `AM` - Armenia + * `AW` - Aruba + * `AU` - Australia + * `AT` - Austria + * `AZ` - Azerbaijan + * `BS` - Bahamas + * `BH` - Bahrain + * `BD` - Bangladesh + * `BB` - Barbados + * `BY` - Belarus + * `BE` - Belgium + * `BZ` - Belize + * `BJ` - Benin + * `BM` - Bermuda + * `BT` - Bhutan + * `BO` - Bolivia + * `BQ` - Bonaire, Sint Eustatius and Saba + * `BA` - Bosnia and Herzegovina + * `BW` - Botswana + * `BV` - Bouvet Island + * `BR` - Brazil + * `IO` - British Indian Ocean Territory + * `BN` - Brunei + * `BG` - Bulgaria + * `BF` - Burkina Faso + * `BI` - Burundi + * `CV` - Cabo Verde + * `KH` - Cambodia + * `CM` - Cameroon + * `CA` - Canada + * `KY` - Cayman Islands + * `CF` - Central African Republic + * `TD` - Chad + * `CL` - Chile + * `CN` - China + * `CX` - Christmas Island + * `CC` - Cocos (Keeling) Islands + * `CO` - Colombia + * `KM` - Comoros + * `CG` - Congo + * `CD` - Congo (the Democratic Republic of the) + * `CK` - Cook Islands + * `CR` - Costa Rica + * `CI` - Côte d'Ivoire + * `HR` - Croatia + * `CU` - Cuba + * `CW` - Curaçao + * `CY` - Cyprus + * `CZ` - Czechia + * `DK` - Denmark + * `DJ` - Djibouti + * `DM` - Dominica + * `DO` - Dominican Republic + * `EC` - Ecuador + * `EG` - Egypt + * `SV` - El Salvador + * `GQ` - Equatorial Guinea + * `ER` - Eritrea + * `EE` - Estonia + * `SZ` - Eswatini + * `ET` - Ethiopia + * `FK` - Falkland Islands (Malvinas) + * `FO` - Faroe Islands + * `FJ` - Fiji + * `FI` - Finland + * `FR` - France + * `GF` - French Guiana + * `PF` - French Polynesia + * `TF` - French Southern Territories + * `GA` - Gabon + * `GM` - Gambia + * `GE` - Georgia + * `DE` - Germany + * `GH` - Ghana + * `GI` - Gibraltar + * `GR` - Greece + * `GL` - Greenland + * `GD` - Grenada + * `GP` - Guadeloupe + * `GU` - Guam + * `GT` - Guatemala + * `GG` - Guernsey + * `GN` - Guinea + * `GW` - Guinea-Bissau + * `GY` - Guyana + * `HT` - Haiti + * `HM` - Heard Island and McDonald Islands + * `VA` - Holy See + * `HN` - Honduras + * `HK` - Hong Kong + * `HU` - Hungary + * `IS` - Iceland + * `IN` - India + * `ID` - Indonesia + * `IR` - Iran + * `IQ` - Iraq + * `IE` - Ireland + * `IM` - Isle of Man + * `IL` - Israel + * `IT` - Italy + * `JM` - Jamaica + * `JP` - Japan + * `JE` - Jersey + * `JO` - Jordan + * `KZ` - Kazakhstan + * `KE` - Kenya + * `KI` - Kiribati + * `KW` - Kuwait + * `KG` - Kyrgyzstan + * `LA` - Laos + * `LV` - Latvia + * `LB` - Lebanon + * `LS` - Lesotho + * `LR` - Liberia + * `LY` - Libya + * `LI` - Liechtenstein + * `LT` - Lithuania + * `LU` - Luxembourg + * `MO` - Macao + * `MG` - Madagascar + * `MW` - Malawi + * `MY` - Malaysia + * `MV` - Maldives + * `ML` - Mali + * `MT` - Malta + * `MH` - Marshall Islands + * `MQ` - Martinique + * `MR` - Mauritania + * `MU` - Mauritius + * `YT` - Mayotte + * `MX` - Mexico + * `FM` - Micronesia (Federated States of) + * `MD` - Moldova + * `MC` - Monaco + * `MN` - Mongolia + * `ME` - Montenegro + * `MS` - Montserrat + * `MA` - Morocco + * `MZ` - Mozambique + * `MM` - Myanmar + * `NA` - Namibia + * `NR` - Nauru + * `NP` - Nepal + * `NL` - Netherlands + * `NC` - New Caledonia + * `NZ` - New Zealand + * `NI` - Nicaragua + * `NE` - Niger + * `NG` - Nigeria + * `NU` - Niue + * `NF` - Norfolk Island + * `KP` - North Korea + * `MK` - North Macedonia + * `MP` - Northern Mariana Islands + * `NO` - Norway + * `OM` - Oman + * `PK` - Pakistan + * `PW` - Palau + * `PS` - Palestine, State of + * `PA` - Panama + * `PG` - Papua New Guinea + * `PY` - Paraguay + * `PE` - Peru + * `PH` - Philippines + * `PN` - Pitcairn + * `PL` - Poland + * `PT` - Portugal + * `PR` - Puerto Rico + * `QA` - Qatar + * `RE` - Réunion + * `RO` - Romania + * `RU` - Russia + * `RW` - Rwanda + * `BL` - Saint Barthélemy + * `SH` - Saint Helena, Ascension and Tristan da Cunha + * `KN` - Saint Kitts and Nevis + * `LC` - Saint Lucia + * `MF` - Saint Martin (French part) + * `PM` - Saint Pierre and Miquelon + * `VC` - Saint Vincent and the Grenadines + * `WS` - Samoa + * `SM` - San Marino + * `ST` - Sao Tome and Principe + * `SA` - Saudi Arabia + * `SN` - Senegal + * `RS` - Serbia + * `SC` - Seychelles + * `SL` - Sierra Leone + * `SG` - Singapore + * `SX` - Sint Maarten (Dutch part) + * `SK` - Slovakia + * `SI` - Slovenia + * `SB` - Solomon Islands + * `SO` - Somalia + * `ZA` - South Africa + * `GS` - South Georgia and the South Sandwich Islands + * `KR` - South Korea + * `SS` - South Sudan + * `ES` - Spain + * `LK` - Sri Lanka + * `SD` - Sudan + * `SR` - Suriname + * `SJ` - Svalbard and Jan Mayen + * `SE` - Sweden + * `CH` - Switzerland + * `SY` - Syria + * `TW` - Taiwan + * `TJ` - Tajikistan + * `TZ` - Tanzania + * `TH` - Thailand + * `TL` - Timor-Leste + * `TG` - Togo + * `TK` - Tokelau + * `TO` - Tonga + * `TT` - Trinidad and Tobago + * `TN` - Tunisia + * `TR` - Turkey + * `TM` - Turkmenistan + * `TC` - Turks and Caicos Islands + * `TV` - Tuvalu + * `UG` - Uganda + * `UA` - Ukraine + * `AE` - United Arab Emirates + * `GB` - United Kingdom + * `UM` - United States Minor Outlying Islands + * `US` - United States of America + * `UY` - Uruguay + * `UZ` - Uzbekistan + * `VU` - Vanuatu + * `VE` - Venezuela + * `VN` - Vietnam + * `VG` - Virgin Islands (British) + * `VI` - Virgin Islands (U.S.) + * `WF` - Wallis and Futuna + * `EH` - Western Sahara + * `YE` - Yemen + * `ZM` - Zambia + * `ZW` - Zimbabwe + union: + - CountryEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + AddressRequest: + docs: >- + # The Address Object - * `GMD` - Gambian Dalasi + ### Description - * `GEK` - Georgian Kupon Larit + The `Address` object is used to represent a contact's or company's + address. - * `GEL` - Georgian Lari - * `DEM` - German Mark + ### Usage Example - * `GHS` - Ghanaian Cedi + Fetch from the `GET CompanyInfo` endpoint and view the company's + addresses. + properties: + type: + type: optional + docs: |- + The address type. - * `GHC` - Ghanaian Cedi (1979–2007) + * `BILLING` - BILLING + * `SHIPPING` - SHIPPING + street_1: + type: optional + docs: Line 1 of the address's street. + street_2: + type: optional + docs: Line 2 of the address's street. + city: + type: optional + docs: The address's city. + country_subdivision: + type: optional + docs: The address's state or region. + country: + type: optional + docs: |- + The address's country. - * `GIP` - Gibraltar Pound + * `AF` - Afghanistan + * `AX` - Åland Islands + * `AL` - Albania + * `DZ` - Algeria + * `AS` - American Samoa + * `AD` - Andorra + * `AO` - Angola + * `AI` - Anguilla + * `AQ` - Antarctica + * `AG` - Antigua and Barbuda + * `AR` - Argentina + * `AM` - Armenia + * `AW` - Aruba + * `AU` - Australia + * `AT` - Austria + * `AZ` - Azerbaijan + * `BS` - Bahamas + * `BH` - Bahrain + * `BD` - Bangladesh + * `BB` - Barbados + * `BY` - Belarus + * `BE` - Belgium + * `BZ` - Belize + * `BJ` - Benin + * `BM` - Bermuda + * `BT` - Bhutan + * `BO` - Bolivia + * `BQ` - Bonaire, Sint Eustatius and Saba + * `BA` - Bosnia and Herzegovina + * `BW` - Botswana + * `BV` - Bouvet Island + * `BR` - Brazil + * `IO` - British Indian Ocean Territory + * `BN` - Brunei + * `BG` - Bulgaria + * `BF` - Burkina Faso + * `BI` - Burundi + * `CV` - Cabo Verde + * `KH` - Cambodia + * `CM` - Cameroon + * `CA` - Canada + * `KY` - Cayman Islands + * `CF` - Central African Republic + * `TD` - Chad + * `CL` - Chile + * `CN` - China + * `CX` - Christmas Island + * `CC` - Cocos (Keeling) Islands + * `CO` - Colombia + * `KM` - Comoros + * `CG` - Congo + * `CD` - Congo (the Democratic Republic of the) + * `CK` - Cook Islands + * `CR` - Costa Rica + * `CI` - Côte d'Ivoire + * `HR` - Croatia + * `CU` - Cuba + * `CW` - Curaçao + * `CY` - Cyprus + * `CZ` - Czechia + * `DK` - Denmark + * `DJ` - Djibouti + * `DM` - Dominica + * `DO` - Dominican Republic + * `EC` - Ecuador + * `EG` - Egypt + * `SV` - El Salvador + * `GQ` - Equatorial Guinea + * `ER` - Eritrea + * `EE` - Estonia + * `SZ` - Eswatini + * `ET` - Ethiopia + * `FK` - Falkland Islands (Malvinas) + * `FO` - Faroe Islands + * `FJ` - Fiji + * `FI` - Finland + * `FR` - France + * `GF` - French Guiana + * `PF` - French Polynesia + * `TF` - French Southern Territories + * `GA` - Gabon + * `GM` - Gambia + * `GE` - Georgia + * `DE` - Germany + * `GH` - Ghana + * `GI` - Gibraltar + * `GR` - Greece + * `GL` - Greenland + * `GD` - Grenada + * `GP` - Guadeloupe + * `GU` - Guam + * `GT` - Guatemala + * `GG` - Guernsey + * `GN` - Guinea + * `GW` - Guinea-Bissau + * `GY` - Guyana + * `HT` - Haiti + * `HM` - Heard Island and McDonald Islands + * `VA` - Holy See + * `HN` - Honduras + * `HK` - Hong Kong + * `HU` - Hungary + * `IS` - Iceland + * `IN` - India + * `ID` - Indonesia + * `IR` - Iran + * `IQ` - Iraq + * `IE` - Ireland + * `IM` - Isle of Man + * `IL` - Israel + * `IT` - Italy + * `JM` - Jamaica + * `JP` - Japan + * `JE` - Jersey + * `JO` - Jordan + * `KZ` - Kazakhstan + * `KE` - Kenya + * `KI` - Kiribati + * `KW` - Kuwait + * `KG` - Kyrgyzstan + * `LA` - Laos + * `LV` - Latvia + * `LB` - Lebanon + * `LS` - Lesotho + * `LR` - Liberia + * `LY` - Libya + * `LI` - Liechtenstein + * `LT` - Lithuania + * `LU` - Luxembourg + * `MO` - Macao + * `MG` - Madagascar + * `MW` - Malawi + * `MY` - Malaysia + * `MV` - Maldives + * `ML` - Mali + * `MT` - Malta + * `MH` - Marshall Islands + * `MQ` - Martinique + * `MR` - Mauritania + * `MU` - Mauritius + * `YT` - Mayotte + * `MX` - Mexico + * `FM` - Micronesia (Federated States of) + * `MD` - Moldova + * `MC` - Monaco + * `MN` - Mongolia + * `ME` - Montenegro + * `MS` - Montserrat + * `MA` - Morocco + * `MZ` - Mozambique + * `MM` - Myanmar + * `NA` - Namibia + * `NR` - Nauru + * `NP` - Nepal + * `NL` - Netherlands + * `NC` - New Caledonia + * `NZ` - New Zealand + * `NI` - Nicaragua + * `NE` - Niger + * `NG` - Nigeria + * `NU` - Niue + * `NF` - Norfolk Island + * `KP` - North Korea + * `MK` - North Macedonia + * `MP` - Northern Mariana Islands + * `NO` - Norway + * `OM` - Oman + * `PK` - Pakistan + * `PW` - Palau + * `PS` - Palestine, State of + * `PA` - Panama + * `PG` - Papua New Guinea + * `PY` - Paraguay + * `PE` - Peru + * `PH` - Philippines + * `PN` - Pitcairn + * `PL` - Poland + * `PT` - Portugal + * `PR` - Puerto Rico + * `QA` - Qatar + * `RE` - Réunion + * `RO` - Romania + * `RU` - Russia + * `RW` - Rwanda + * `BL` - Saint Barthélemy + * `SH` - Saint Helena, Ascension and Tristan da Cunha + * `KN` - Saint Kitts and Nevis + * `LC` - Saint Lucia + * `MF` - Saint Martin (French part) + * `PM` - Saint Pierre and Miquelon + * `VC` - Saint Vincent and the Grenadines + * `WS` - Samoa + * `SM` - San Marino + * `ST` - Sao Tome and Principe + * `SA` - Saudi Arabia + * `SN` - Senegal + * `RS` - Serbia + * `SC` - Seychelles + * `SL` - Sierra Leone + * `SG` - Singapore + * `SX` - Sint Maarten (Dutch part) + * `SK` - Slovakia + * `SI` - Slovenia + * `SB` - Solomon Islands + * `SO` - Somalia + * `ZA` - South Africa + * `GS` - South Georgia and the South Sandwich Islands + * `KR` - South Korea + * `SS` - South Sudan + * `ES` - Spain + * `LK` - Sri Lanka + * `SD` - Sudan + * `SR` - Suriname + * `SJ` - Svalbard and Jan Mayen + * `SE` - Sweden + * `CH` - Switzerland + * `SY` - Syria + * `TW` - Taiwan + * `TJ` - Tajikistan + * `TZ` - Tanzania + * `TH` - Thailand + * `TL` - Timor-Leste + * `TG` - Togo + * `TK` - Tokelau + * `TO` - Tonga + * `TT` - Trinidad and Tobago + * `TN` - Tunisia + * `TR` - Turkey + * `TM` - Turkmenistan + * `TC` - Turks and Caicos Islands + * `TV` - Tuvalu + * `UG` - Uganda + * `UA` - Ukraine + * `AE` - United Arab Emirates + * `GB` - United Kingdom + * `UM` - United States Minor Outlying Islands + * `US` - United States of America + * `UY` - Uruguay + * `UZ` - Uzbekistan + * `VU` - Vanuatu + * `VE` - Venezuela + * `VN` - Vietnam + * `VG` - Virgin Islands (British) + * `VI` - Virgin Islands (U.S.) + * `WF` - Wallis and Futuna + * `EH` - Western Sahara + * `YE` - Yemen + * `ZM` - Zambia + * `ZW` - Zimbabwe + zip_code: + type: optional + docs: The address's zip code. + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + AddressTypeEnum: + enum: + - BILLING + - SHIPPING + docs: |- + * `BILLING` - BILLING + * `SHIPPING` - SHIPPING + source: + openapi: openapi/openapi.yml + AdvancedMetadata: + properties: + id: + type: string + validation: + format: uuid + display_name: optional + description: optional + is_required: optional + is_custom: optional + field_choices: optional> + source: + openapi: openapi/openapi.yml + AsyncPassthroughReciept: + properties: + async_passthrough_receipt_id: + type: string + validation: + format: uuid + source: + openapi: openapi/openapi.yml + AsyncPostTaskStatus: + discriminated: false + union: + - AsyncPostTaskStatusEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + AsyncPostTask: + properties: + status: AsyncPostTaskStatus + result: AsyncPostTaskResult + source: + openapi: openapi/openapi.yml + AsyncPostTaskResult: + properties: + status_code: optional + response: optional> + source: + openapi: openapi/openapi.yml + AsyncPostTaskStatusEnum: + enum: + - QUEUED + - IN_PROGRESS + - COMPLETED + - FAILURE + docs: |- + * `QUEUED` - QUEUED + * `IN_PROGRESS` - IN_PROGRESS + * `COMPLETED` - COMPLETED + * `FAILURE` - FAILURE + source: + openapi: openapi/openapi.yml + AuditLogEventRole: + discriminated: false + docs: >- + Designates the role of the user (or SYSTEM/API if action not taken by a + user) at the time of this Event occurring. - * `XAU` - Gold - * `GRD` - Greek Drachma + * `ADMIN` - ADMIN - * `GTQ` - Guatemalan Quetzal + * `DEVELOPER` - DEVELOPER - * `GWP` - Guinea-Bissau Peso + * `MEMBER` - MEMBER - * `GNF` - Guinean Franc + * `API` - API - * `GNS` - Guinean Syli + * `SYSTEM` - SYSTEM - * `GYD` - Guyanaese Dollar + * `MERGE_TEAM` - MERGE_TEAM + union: + - RoleEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + AuditLogEventEventType: + discriminated: false + docs: >- + Designates the type of event that occurred. - * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira + * `CREATED_REMOTE_PRODUCTION_API_KEY` - CREATED_REMOTE_PRODUCTION_API_KEY - * `HKD` - Hong Kong Dollar + * `DELETED_REMOTE_PRODUCTION_API_KEY` - DELETED_REMOTE_PRODUCTION_API_KEY - * `HUF` - Hungarian Forint + * `CREATED_TEST_API_KEY` - CREATED_TEST_API_KEY - * `IMP` - IMP + * `DELETED_TEST_API_KEY` - DELETED_TEST_API_KEY - * `ISK` - Icelandic Króna + * `REGENERATED_PRODUCTION_API_KEY` - REGENERATED_PRODUCTION_API_KEY - * `ISJ` - Icelandic Króna (1918–1981) + * `REGENERATED_WEBHOOK_SIGNATURE` - REGENERATED_WEBHOOK_SIGNATURE - * `INR` - Indian Rupee + * `INVITED_USER` - INVITED_USER - * `IDR` - Indonesian Rupiah + * `TWO_FACTOR_AUTH_ENABLED` - TWO_FACTOR_AUTH_ENABLED - * `IRR` - Iranian Rial + * `TWO_FACTOR_AUTH_DISABLED` - TWO_FACTOR_AUTH_DISABLED - * `IQD` - Iraqi Dinar + * `DELETED_LINKED_ACCOUNT` - DELETED_LINKED_ACCOUNT - * `IEP` - Irish Pound + * `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT` - + DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT - * `ILS` - Israeli New Shekel + * `CREATED_DESTINATION` - CREATED_DESTINATION - * `ILP` - Israeli Pound + * `DELETED_DESTINATION` - DELETED_DESTINATION - * `ILR` - Israeli Shekel (1980–1985) + * `CHANGED_DESTINATION` - CHANGED_DESTINATION - * `ITL` - Italian Lira + * `CHANGED_SCOPES` - CHANGED_SCOPES - * `JMD` - Jamaican Dollar + * `CHANGED_PERSONAL_INFORMATION` - CHANGED_PERSONAL_INFORMATION - * `JPY` - Japanese Yen + * `CHANGED_ORGANIZATION_SETTINGS` - CHANGED_ORGANIZATION_SETTINGS - * `JOD` - Jordanian Dinar + * `ENABLED_INTEGRATION` - ENABLED_INTEGRATION - * `KZT` - Kazakhstani Tenge + * `DISABLED_INTEGRATION` - DISABLED_INTEGRATION - * `KES` - Kenyan Shilling + * `ENABLED_CATEGORY` - ENABLED_CATEGORY - * `KWD` - Kuwaiti Dinar + * `DISABLED_CATEGORY` - DISABLED_CATEGORY - * `KGS` - Kyrgystani Som + * `CHANGED_PASSWORD` - CHANGED_PASSWORD - * `LAK` - Laotian Kip + * `RESET_PASSWORD` - RESET_PASSWORD - * `LVL` - Latvian Lats + * `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - + ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION - * `LVR` - Latvian Ruble + * `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - + ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT - * `LBP` - Lebanese Pound + * `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - + DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION - * `LSL` - Lesotho Loti + * `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - + DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT - * `LRD` - Liberian Dollar + * `CREATED_INTEGRATION_WIDE_FIELD_MAPPING` - + CREATED_INTEGRATION_WIDE_FIELD_MAPPING - * `LYD` - Libyan Dinar + * `CREATED_LINKED_ACCOUNT_FIELD_MAPPING` - + CREATED_LINKED_ACCOUNT_FIELD_MAPPING - * `LTL` - Lithuanian Litas + * `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING` - + CHANGED_INTEGRATION_WIDE_FIELD_MAPPING - * `LTT` - Lithuanian Talonas + * `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING` - + CHANGED_LINKED_ACCOUNT_FIELD_MAPPING - * `LUL` - Luxembourg Financial Franc + * `DELETED_INTEGRATION_WIDE_FIELD_MAPPING` - + DELETED_INTEGRATION_WIDE_FIELD_MAPPING - * `LUC` - Luxembourgian Convertible Franc + * `DELETED_LINKED_ACCOUNT_FIELD_MAPPING` - + DELETED_LINKED_ACCOUNT_FIELD_MAPPING - * `LUF` - Luxembourgian Franc + * `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - + CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE - * `MOP` - Macanese Pataca + * `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - + CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE - * `MKD` - Macedonian Denar + * `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - + DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE - * `MKN` - Macedonian Denar (1992–1993) + * `FORCED_LINKED_ACCOUNT_RESYNC` - FORCED_LINKED_ACCOUNT_RESYNC - * `MGA` - Malagasy Ariary + * `MUTED_ISSUE` - MUTED_ISSUE - * `MGF` - Malagasy Franc + * `GENERATED_MAGIC_LINK` - GENERATED_MAGIC_LINK - * `MWK` - Malawian Kwacha + * `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK - * `MYR` - Malaysian Ringgit + * `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK - * `MVR` - Maldivian Rufiyaa + * `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED - * `MVP` - Maldivian Rupee (1947–1981) + * `END_USER_CREDENTIALS_ACCESSED` - END_USER_CREDENTIALS_ACCESSED + union: + - EventTypeEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + AuditLogEvent: + properties: + id: + type: optional + validation: + format: uuid + access: read-only + user_name: + type: optional + docs: The User's full name at the time of this Event occurring. + validation: + maxLength: 200 + user_email: + type: optional + docs: The User's email at the time of this Event occurring. + validation: + format: email + maxLength: 254 + role: + type: AuditLogEventRole + docs: >- + Designates the role of the user (or SYSTEM/API if action not taken by + a user) at the time of this Event occurring. - * `MLF` - Malian Franc - * `MTL` - Maltese Lira + * `ADMIN` - ADMIN - * `MTP` - Maltese Pound + * `DEVELOPER` - DEVELOPER - * `MRU` - Mauritanian Ouguiya + * `MEMBER` - MEMBER - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `API` - API - * `MUR` - Mauritian Rupee + * `SYSTEM` - SYSTEM - * `MXV` - Mexican Investment Unit + * `MERGE_TEAM` - MERGE_TEAM + ip_address: + type: string + validation: + maxLength: 45 + event_type: + type: AuditLogEventEventType + docs: >- + Designates the type of event that occurred. - * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) + * `CREATED_REMOTE_PRODUCTION_API_KEY` - + CREATED_REMOTE_PRODUCTION_API_KEY - * `MDC` - Moldovan Cupon + * `DELETED_REMOTE_PRODUCTION_API_KEY` - + DELETED_REMOTE_PRODUCTION_API_KEY - * `MDL` - Moldovan Leu + * `CREATED_TEST_API_KEY` - CREATED_TEST_API_KEY - * `MCF` - Monegasque Franc + * `DELETED_TEST_API_KEY` - DELETED_TEST_API_KEY - * `MNT` - Mongolian Tugrik + * `REGENERATED_PRODUCTION_API_KEY` - REGENERATED_PRODUCTION_API_KEY - * `MAD` - Moroccan Dirham + * `REGENERATED_WEBHOOK_SIGNATURE` - REGENERATED_WEBHOOK_SIGNATURE - * `MAF` - Moroccan Franc + * `INVITED_USER` - INVITED_USER - * `MZE` - Mozambican Escudo + * `TWO_FACTOR_AUTH_ENABLED` - TWO_FACTOR_AUTH_ENABLED - * `MZN` - Mozambican Metical + * `TWO_FACTOR_AUTH_DISABLED` - TWO_FACTOR_AUTH_DISABLED - * `MZM` - Mozambican Metical (1980–2006) + * `DELETED_LINKED_ACCOUNT` - DELETED_LINKED_ACCOUNT - * `MMK` - Myanmar Kyat + * `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT` - + DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT - * `NAD` - Namibian Dollar + * `CREATED_DESTINATION` - CREATED_DESTINATION - * `NPR` - Nepalese Rupee + * `DELETED_DESTINATION` - DELETED_DESTINATION - * `ANG` - Netherlands Antillean Guilder + * `CHANGED_DESTINATION` - CHANGED_DESTINATION - * `TWD` - New Taiwan Dollar + * `CHANGED_SCOPES` - CHANGED_SCOPES - * `NZD` - New Zealand Dollar + * `CHANGED_PERSONAL_INFORMATION` - CHANGED_PERSONAL_INFORMATION - * `NIO` - Nicaraguan Córdoba + * `CHANGED_ORGANIZATION_SETTINGS` - CHANGED_ORGANIZATION_SETTINGS - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `ENABLED_INTEGRATION` - ENABLED_INTEGRATION - * `NGN` - Nigerian Naira + * `DISABLED_INTEGRATION` - DISABLED_INTEGRATION - * `KPW` - North Korean Won + * `ENABLED_CATEGORY` - ENABLED_CATEGORY - * `NOK` - Norwegian Krone + * `DISABLED_CATEGORY` - DISABLED_CATEGORY - * `OMR` - Omani Rial + * `CHANGED_PASSWORD` - CHANGED_PASSWORD - * `PKR` - Pakistani Rupee + * `RESET_PASSWORD` - RESET_PASSWORD - * `XPD` - Palladium + * `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - + ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION - * `PAB` - Panamanian Balboa + * `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - + ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT - * `PGK` - Papua New Guinean Kina + * `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - + DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION - * `PYG` - Paraguayan Guarani + * `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - + DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT - * `PEI` - Peruvian Inti + * `CREATED_INTEGRATION_WIDE_FIELD_MAPPING` - + CREATED_INTEGRATION_WIDE_FIELD_MAPPING - * `PEN` - Peruvian Sol + * `CREATED_LINKED_ACCOUNT_FIELD_MAPPING` - + CREATED_LINKED_ACCOUNT_FIELD_MAPPING - * `PES` - Peruvian Sol (1863–1965) + * `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING` - + CHANGED_INTEGRATION_WIDE_FIELD_MAPPING - * `PHP` - Philippine Peso + * `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING` - + CHANGED_LINKED_ACCOUNT_FIELD_MAPPING - * `XPT` - Platinum + * `DELETED_INTEGRATION_WIDE_FIELD_MAPPING` - + DELETED_INTEGRATION_WIDE_FIELD_MAPPING - * `PLN` - Polish Zloty + * `DELETED_LINKED_ACCOUNT_FIELD_MAPPING` - + DELETED_LINKED_ACCOUNT_FIELD_MAPPING - * `PLZ` - Polish Zloty (1950–1995) + * `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - + CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE - * `PTE` - Portuguese Escudo + * `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - + CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE - * `GWE` - Portuguese Guinea Escudo + * `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - + DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE - * `QAR` - Qatari Rial + * `FORCED_LINKED_ACCOUNT_RESYNC` - FORCED_LINKED_ACCOUNT_RESYNC - * `XRE` - RINET Funds + * `MUTED_ISSUE` - MUTED_ISSUE - * `RHD` - Rhodesian Dollar + * `GENERATED_MAGIC_LINK` - GENERATED_MAGIC_LINK - * `RON` - Romanian Leu + * `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK - * `ROL` - Romanian Leu (1952–2006) + * `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK - * `RUB` - Russian Ruble + * `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED - * `RUR` - Russian Ruble (1991–1998) + * `END_USER_CREDENTIALS_ACCESSED` - END_USER_CREDENTIALS_ACCESSED + event_description: string + created_at: + type: optional + access: read-only + source: + openapi: openapi/openapi.yml + AvailableActions: + docs: >- + # The AvailableActions Object - * `RWF` - Rwandan Franc + ### Description - * `SVC` - Salvadoran Colón + The `Activity` object is used to see all available model/operation + combinations for an integration. - * `WST` - Samoan Tala - * `SAR` - Saudi Riyal + ### Usage Example - * `RSD` - Serbian Dinar + Fetch all the actions available for the `Zenefits` integration. + properties: + integration: AccountIntegration + passthrough_available: boolean + available_model_operations: optional> + source: + openapi: openapi/openapi.yml + BalanceSheetCurrency: + discriminated: false + docs: >- + The balance sheet's currency. - * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee + * `XUA` - ADB Unit of Account - * `SLL` - Sierra Leonean Leone + * `AFN` - Afghan Afghani - * `XAG` - Silver + * `AFA` - Afghan Afghani (1927–2002) - * `SGD` - Singapore Dollar + * `ALL` - Albanian Lek - * `SKK` - Slovak Koruna + * `ALK` - Albanian Lek (1946–1965) - * `SIT` - Slovenian Tolar + * `DZD` - Algerian Dinar - * `SBD` - Solomon Islands Dollar + * `ADP` - Andorran Peseta - * `SOS` - Somali Shilling + * `AOA` - Angolan Kwanza - * `ZAR` - South African Rand + * `AOK` - Angolan Kwanza (1977–1991) - * `ZAL` - South African Rand (financial) + * `AON` - Angolan New Kwanza (1990–2000) - * `KRH` - South Korean Hwan (1953–1962) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `KRW` - South Korean Won + * `ARA` - Argentine Austral - * `KRO` - South Korean Won (1945–1953) + * `ARS` - Argentine Peso - * `SSP` - South Sudanese Pound + * `ARM` - Argentine Peso (1881–1970) - * `SUR` - Soviet Rouble + * `ARP` - Argentine Peso (1983–1985) - * `ESP` - Spanish Peseta + * `ARL` - Argentine Peso Ley (1970–1983) - * `ESA` - Spanish Peseta (A account) + * `AMD` - Armenian Dram - * `ESB` - Spanish Peseta (convertible account) + * `AWG` - Aruban Florin - * `XDR` - Special Drawing Rights + * `AUD` - Australian Dollar - * `LKR` - Sri Lankan Rupee + * `ATS` - Austrian Schilling - * `SHP` - St. Helena Pound + * `AZN` - Azerbaijani Manat - * `XSU` - Sucre + * `AZM` - Azerbaijani Manat (1993–2006) - * `SDD` - Sudanese Dinar (1992–2007) + * `BSD` - Bahamian Dollar - * `SDG` - Sudanese Pound + * `BHD` - Bahraini Dinar - * `SDP` - Sudanese Pound (1957–1998) + * `BDT` - Bangladeshi Taka - * `SRD` - Surinamese Dollar + * `BBD` - Barbadian Dollar - * `SRG` - Surinamese Guilder + * `BYN` - Belarusian Ruble - * `SZL` - Swazi Lilangeni + * `BYB` - Belarusian Ruble (1994–1999) - * `SEK` - Swedish Krona + * `BYR` - Belarusian Ruble (2000–2016) - * `CHF` - Swiss Franc + * `BEF` - Belgian Franc - * `SYP` - Syrian Pound + * `BEC` - Belgian Franc (convertible) - * `STN` - São Tomé & Príncipe Dobra + * `BEL` - Belgian Franc (financial) - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `BZD` - Belize Dollar - * `TVD` - TVD + * `BMD` - Bermudan Dollar - * `TJR` - Tajikistani Ruble + * `BTN` - Bhutanese Ngultrum - * `TJS` - Tajikistani Somoni + * `BOB` - Bolivian Boliviano - * `TZS` - Tanzanian Shilling + * `BOL` - Bolivian Boliviano (1863–1963) - * `XTS` - Testing Currency Code + * `BOV` - Bolivian Mvdol - * `THB` - Thai Baht + * `BOP` - Bolivian Peso - * `XXX` - The codes assigned for transactions where no currency is - involved + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `TPE` - Timorese Escudo + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `TOP` - Tongan Paʻanga + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `TTD` - Trinidad & Tobago Dollar + * `BWP` - Botswanan Pula - * `TND` - Tunisian Dinar + * `BRC` - Brazilian Cruzado (1986–1989) - * `TRY` - Turkish Lira + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `TRL` - Turkish Lira (1922–2005) + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `TMT` - Turkmenistani Manat + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `TMM` - Turkmenistani Manat (1993–2009) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `USD` - US Dollar + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `USN` - US Dollar (Next day) + * `BRL` - Brazilian Real - * `USS` - US Dollar (Same day) + * `GBP` - British Pound - * `UGX` - Ugandan Shilling + * `BND` - Brunei Dollar - * `UGS` - Ugandan Shilling (1966–1987) + * `BGL` - Bulgarian Hard Lev - * `UAH` - Ukrainian Hryvnia + * `BGN` - Bulgarian Lev - * `UAK` - Ukrainian Karbovanets + * `BGO` - Bulgarian Lev (1879–1952) - * `AED` - United Arab Emirates Dirham + * `BGM` - Bulgarian Socialist Lev - * `UYW` - Uruguayan Nominal Wage Index Unit + * `BUK` - Burmese Kyat - * `UYU` - Uruguayan Peso + * `BIF` - Burundian Franc - * `UYP` - Uruguayan Peso (1975–1993) + * `XPF` - CFP Franc - * `UYI` - Uruguayan Peso (Indexed Units) + * `KHR` - Cambodian Riel - * `UZS` - Uzbekistani Som + * `CAD` - Canadian Dollar - * `VUV` - Vanuatu Vatu + * `CVE` - Cape Verdean Escudo - * `VES` - Venezuelan Bolívar + * `KYD` - Cayman Islands Dollar - * `VEB` - Venezuelan Bolívar (1871–2008) + * `XAF` - Central African CFA Franc - * `VEF` - Venezuelan Bolívar (2008–2018) + * `CLE` - Chilean Escudo - * `VND` - Vietnamese Dong + * `CLP` - Chilean Peso - * `VNN` - Vietnamese Dong (1978–1985) + * `CLF` - Chilean Unit of Account (UF) - * `CHE` - WIR Euro + * `CNX` - Chinese People’s Bank Dollar - * `CHW` - WIR Franc + * `CNY` - Chinese Yuan - * `XOF` - West African CFA Franc + * `CNH` - Chinese Yuan (offshore) - * `YDD` - Yemeni Dinar + * `COP` - Colombian Peso - * `YER` - Yemeni Rial + * `COU` - Colombian Real Value Unit - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `KMF` - Comorian Franc - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `CDF` - Congolese Franc - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `CRC` - Costa Rican Colón - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `HRD` - Croatian Dinar - * `ZWN` - ZWN + * `HRK` - Croatian Kuna - * `ZRN` - Zairean New Zaire (1993–1998) + * `CUC` - Cuban Convertible Peso - * `ZRZ` - Zairean Zaire (1971–1993) + * `CUP` - Cuban Peso - * `ZMW` - Zambian Kwacha + * `CYP` - Cypriot Pound - * `ZMK` - Zambian Kwacha (1968–2012) + * `CZK` - Czech Koruna - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `CSK` - Czechoslovak Hard Koruna - * `ZWR` - Zimbabwean Dollar (2008) + * `DKK` - Danish Krone - * `ZWL` - Zimbabwean Dollar (2009) - account_number: - type: optional - docs: The account's number. - parent_account: - type: optional - docs: ID of the parent account. - validation: - format: uuid - company: - type: optional - docs: The company the account belongs to. - validation: - format: uuid - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - AccountResponse: - properties: - model: Account - warnings: list - errors: list - logs: optional> - source: - openapi: openapi/openapi.yml - AccountStatusEnum: - enum: - - ACTIVE - - PENDING - - INACTIVE - docs: |- - * `ACTIVE` - ACTIVE - * `PENDING` - PENDING - * `INACTIVE` - INACTIVE - source: - openapi: openapi/openapi.yml - AccountToken: - properties: - account_token: string - integration: AccountIntegration - id: string - source: - openapi: openapi/openapi.yml - AccountingAttachment: - docs: >- - # The Accounting Attachment Object + * `DJF` - Djiboutian Franc - ### Description + * `DOP` - Dominican Peso - The `AccountingAttachment` object is used to represent a company's - attachments. + * `NLG` - Dutch Guilder + * `XCD` - East Caribbean Dollar - ### Usage Example + * `DDM` - East German Mark - Fetch from the `LIST AccountingAttachments` endpoint and view a company's - attachments. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - file_name: - type: optional - docs: The attachment's name. - file_url: - type: optional - docs: The attachment's url. - validation: - format: uri - maxLength: 2000 - company: - type: optional - docs: The company the accounting attachment belongs to. - validation: - format: uuid - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - AccountingAttachmentRequest: - docs: >- - # The Accounting Attachment Object + * `ECS` - Ecuadorian Sucre - ### Description + * `ECV` - Ecuadorian Unit of Constant Value - The `AccountingAttachment` object is used to represent a company's - attachments. + * `EGP` - Egyptian Pound + * `GQE` - Equatorial Guinean Ekwele - ### Usage Example + * `ERN` - Eritrean Nakfa - Fetch from the `LIST AccountingAttachments` endpoint and view a company's - attachments. - properties: - file_name: - type: optional - docs: The attachment's name. - file_url: - type: optional - docs: The attachment's url. - validation: - format: uri - maxLength: 2000 - company: - type: optional - docs: The company the accounting attachment belongs to. - validation: - format: uuid - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - AccountingAttachmentResponse: - properties: - model: AccountingAttachment - warnings: list - errors: list - logs: optional> - source: - openapi: openapi/openapi.yml - AccountingPeriodStatus: - discriminated: false - union: - - Status895Enum - - string - source: - openapi: openapi/openapi.yml - inline: true - AccountingPeriod: - docs: >- - # The AccountingPeriod Object + * `EEK` - Estonian Kroon - ### Description + * `ETB` - Ethiopian Birr - The `AccountingPeriod` object is used to define a period of time in which - events occurred. + * `EUR` - Euro + * `XBA` - European Composite Unit - ### Usage Example + * `XEU` - European Currency Unit - Common models like `Invoice` and `Transaction` will have - `AccountingPeriod` objects which will denote when they occurred. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - name: - type: optional - docs: Name of the accounting period. - validation: - maxLength: 100 - status: optional - start_date: - type: optional - docs: Beginning date of the period - end_date: - type: optional - docs: End date of the period - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - AccountingPhoneNumber: - docs: >- - # The AccountingPhoneNumber Object + * `XBB` - European Monetary Unit - ### Description + * `XBC` - European Unit of Account (XBC) - The `AccountingPhoneNumber` object is used to represent a contact's or - company's phone number. + * `XBD` - European Unit of Account (XBD) + + * `FKP` - Falkland Islands Pound + + * `FJD` - Fijian Dollar + + * `FIM` - Finnish Markka + + * `FRF` - French Franc + + * `XFO` - French Gold Franc + + * `XFU` - French UIC-Franc + + * `GMD` - Gambian Dalasi + + * `GEK` - Georgian Kupon Larit + + * `GEL` - Georgian Lari + + * `DEM` - German Mark + + * `GHS` - Ghanaian Cedi + + * `GHC` - Ghanaian Cedi (1979–2007) + + * `GIP` - Gibraltar Pound + + * `XAU` - Gold + + * `GRD` - Greek Drachma + + * `GTQ` - Guatemalan Quetzal + + * `GWP` - Guinea-Bissau Peso + + * `GNF` - Guinean Franc + + * `GNS` - Guinean Syli + + * `GYD` - Guyanaese Dollar + + * `HTG` - Haitian Gourde + + * `HNL` - Honduran Lempira + + * `HKD` - Hong Kong Dollar + + * `HUF` - Hungarian Forint + + * `IMP` - IMP + + * `ISK` - Icelandic Króna + + * `ISJ` - Icelandic Króna (1918–1981) + + * `INR` - Indian Rupee + + * `IDR` - Indonesian Rupiah + + * `IRR` - Iranian Rial + + * `IQD` - Iraqi Dinar + + * `IEP` - Irish Pound + + * `ILS` - Israeli New Shekel + + * `ILP` - Israeli Pound + + * `ILR` - Israeli Shekel (1980–1985) + + * `ITL` - Italian Lira + + * `JMD` - Jamaican Dollar + + * `JPY` - Japanese Yen + + * `JOD` - Jordanian Dinar + + * `KZT` - Kazakhstani Tenge + + * `KES` - Kenyan Shilling + + * `KWD` - Kuwaiti Dinar + + * `KGS` - Kyrgystani Som + + * `LAK` - Laotian Kip + + * `LVL` - Latvian Lats + + * `LVR` - Latvian Ruble + + * `LBP` - Lebanese Pound + + * `LSL` - Lesotho Loti + + * `LRD` - Liberian Dollar + + * `LYD` - Libyan Dinar + + * `LTL` - Lithuanian Litas + + * `LTT` - Lithuanian Talonas + + * `LUL` - Luxembourg Financial Franc + + * `LUC` - Luxembourgian Convertible Franc + + * `LUF` - Luxembourgian Franc + + * `MOP` - Macanese Pataca + + * `MKD` - Macedonian Denar + + * `MKN` - Macedonian Denar (1992–1993) + + * `MGA` - Malagasy Ariary + + * `MGF` - Malagasy Franc + + * `MWK` - Malawian Kwacha + + * `MYR` - Malaysian Ringgit + + * `MVR` - Maldivian Rufiyaa + + * `MVP` - Maldivian Rupee (1947–1981) + + * `MLF` - Malian Franc + + * `MTL` - Maltese Lira + + * `MTP` - Maltese Pound + + * `MRU` - Mauritanian Ouguiya + + * `MRO` - Mauritanian Ouguiya (1973–2017) + + * `MUR` - Mauritian Rupee + + * `MXV` - Mexican Investment Unit + + * `MXN` - Mexican Peso + + * `MXP` - Mexican Silver Peso (1861–1992) + + * `MDC` - Moldovan Cupon + + * `MDL` - Moldovan Leu + + * `MCF` - Monegasque Franc + + * `MNT` - Mongolian Tugrik + + * `MAD` - Moroccan Dirham + + * `MAF` - Moroccan Franc + + * `MZE` - Mozambican Escudo + + * `MZN` - Mozambican Metical + + * `MZM` - Mozambican Metical (1980–2006) + + * `MMK` - Myanmar Kyat + + * `NAD` - Namibian Dollar + + * `NPR` - Nepalese Rupee + + * `ANG` - Netherlands Antillean Guilder + + * `TWD` - New Taiwan Dollar + + * `NZD` - New Zealand Dollar + + * `NIO` - Nicaraguan Córdoba + + * `NIC` - Nicaraguan Córdoba (1988–1991) + + * `NGN` - Nigerian Naira + + * `KPW` - North Korean Won + + * `NOK` - Norwegian Krone + + * `OMR` - Omani Rial + + * `PKR` - Pakistani Rupee + + * `XPD` - Palladium + + * `PAB` - Panamanian Balboa + + * `PGK` - Papua New Guinean Kina + + * `PYG` - Paraguayan Guarani + + * `PEI` - Peruvian Inti + + * `PEN` - Peruvian Sol + + * `PES` - Peruvian Sol (1863–1965) + + * `PHP` - Philippine Peso + + * `XPT` - Platinum + + * `PLN` - Polish Zloty + + * `PLZ` - Polish Zloty (1950–1995) + + * `PTE` - Portuguese Escudo + + * `GWE` - Portuguese Guinea Escudo + + * `QAR` - Qatari Rial + + * `XRE` - RINET Funds + + * `RHD` - Rhodesian Dollar + + * `RON` - Romanian Leu + + * `ROL` - Romanian Leu (1952–2006) + + * `RUB` - Russian Ruble + + * `RUR` - Russian Ruble (1991–1998) + + * `RWF` - Rwandan Franc + + * `SVC` - Salvadoran Colón + + * `WST` - Samoan Tala + + * `SAR` - Saudi Riyal + + * `RSD` - Serbian Dinar + + * `CSD` - Serbian Dinar (2002–2006) + + * `SCR` - Seychellois Rupee + + * `SLL` - Sierra Leonean Leone + + * `XAG` - Silver + + * `SGD` - Singapore Dollar + + * `SKK` - Slovak Koruna + + * `SIT` - Slovenian Tolar + + * `SBD` - Solomon Islands Dollar + + * `SOS` - Somali Shilling + + * `ZAR` - South African Rand + + * `ZAL` - South African Rand (financial) + + * `KRH` - South Korean Hwan (1953–1962) + + * `KRW` - South Korean Won + + * `KRO` - South Korean Won (1945–1953) + + * `SSP` - South Sudanese Pound + + * `SUR` - Soviet Rouble + + * `ESP` - Spanish Peseta + + * `ESA` - Spanish Peseta (A account) + + * `ESB` - Spanish Peseta (convertible account) + + * `XDR` - Special Drawing Rights + + * `LKR` - Sri Lankan Rupee + + * `SHP` - St. Helena Pound + + * `XSU` - Sucre + + * `SDD` - Sudanese Dinar (1992–2007) + + * `SDG` - Sudanese Pound + + * `SDP` - Sudanese Pound (1957–1998) + + * `SRD` - Surinamese Dollar + + * `SRG` - Surinamese Guilder + + * `SZL` - Swazi Lilangeni + + * `SEK` - Swedish Krona + + * `CHF` - Swiss Franc + + * `SYP` - Syrian Pound + + * `STN` - São Tomé & Príncipe Dobra + + * `STD` - São Tomé & Príncipe Dobra (1977–2017) + + * `TVD` - TVD + + * `TJR` - Tajikistani Ruble + + * `TJS` - Tajikistani Somoni + + * `TZS` - Tanzanian Shilling + + * `XTS` - Testing Currency Code + + * `THB` - Thai Baht + + * `XXX` - The codes assigned for transactions where no currency is + involved + + * `TPE` - Timorese Escudo + + * `TOP` - Tongan Paʻanga + + * `TTD` - Trinidad & Tobago Dollar + + * `TND` - Tunisian Dinar + + * `TRY` - Turkish Lira + + * `TRL` - Turkish Lira (1922–2005) + + * `TMT` - Turkmenistani Manat + + * `TMM` - Turkmenistani Manat (1993–2009) + + * `USD` - US Dollar + + * `USN` - US Dollar (Next day) + + * `USS` - US Dollar (Same day) + + * `UGX` - Ugandan Shilling + + * `UGS` - Ugandan Shilling (1966–1987) + + * `UAH` - Ukrainian Hryvnia + + * `UAK` - Ukrainian Karbovanets + + * `AED` - United Arab Emirates Dirham + + * `UYW` - Uruguayan Nominal Wage Index Unit + + * `UYU` - Uruguayan Peso + + * `UYP` - Uruguayan Peso (1975–1993) + + * `UYI` - Uruguayan Peso (Indexed Units) + + * `UZS` - Uzbekistani Som + + * `VUV` - Vanuatu Vatu + + * `VES` - Venezuelan Bolívar + + * `VEB` - Venezuelan Bolívar (1871–2008) + + * `VEF` - Venezuelan Bolívar (2008–2018) + + * `VND` - Vietnamese Dong + + * `VNN` - Vietnamese Dong (1978–1985) + + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) + union: + - TransactionCurrencyEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + BalanceSheetCompany: + discriminated: false + docs: '`Company` object for the given `BalanceSheet` object.' + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + BalanceSheet: + docs: >- + # The BalanceSheet Object + + ### Description + + The `BalanceSheet` object shows a company’s assets, liabilities, and + equity. Assets should be equal to liability and equity combined. This + shows the company’s financial health at a specific point in time. ### Usage Example - Fetch from the `GET CompanyInfo` endpoint and view the company's phone - numbers. + Fetch from the `LIST BalanceSheets` endpoint and view a company's balance + sheets. properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. created_at: type: optional docs: The datetime that this object was created by Merge. @@ -3312,1599 +4294,704 @@ types: type: optional docs: The datetime that this object was modified by Merge. access: read-only - number: - type: optional - docs: The phone number. - type: + name: type: optional - docs: The phone number's type. - source: - openapi: openapi/openapi.yml - AccountingPhoneNumberRequest: - docs: >- - # The AccountingPhoneNumber Object + docs: The balance sheet's name. + currency: + type: optional + docs: >- + The balance sheet's currency. - ### Description - The `AccountingPhoneNumber` object is used to represent a contact's or - company's phone number. + * `XUA` - ADB Unit of Account + * `AFN` - Afghan Afghani - ### Usage Example + * `AFA` - Afghan Afghani (1927–2002) - Fetch from the `GET CompanyInfo` endpoint and view the company's phone - numbers. - properties: - number: - type: optional - docs: The phone number. - type: - type: optional - docs: The phone number's type. - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - AddressType: - discriminated: false - docs: |- - The address type. + * `ALL` - Albanian Lek - * `BILLING` - BILLING - * `SHIPPING` - SHIPPING - union: - - AddressTypeEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - AddressCountry: - discriminated: false - docs: |- - The address's country. + * `ALK` - Albanian Lek (1946–1965) - * `AF` - Afghanistan - * `AX` - Åland Islands - * `AL` - Albania - * `DZ` - Algeria - * `AS` - American Samoa - * `AD` - Andorra - * `AO` - Angola - * `AI` - Anguilla - * `AQ` - Antarctica - * `AG` - Antigua and Barbuda - * `AR` - Argentina - * `AM` - Armenia - * `AW` - Aruba - * `AU` - Australia - * `AT` - Austria - * `AZ` - Azerbaijan - * `BS` - Bahamas - * `BH` - Bahrain - * `BD` - Bangladesh - * `BB` - Barbados - * `BY` - Belarus - * `BE` - Belgium - * `BZ` - Belize - * `BJ` - Benin - * `BM` - Bermuda - * `BT` - Bhutan - * `BO` - Bolivia - * `BQ` - Bonaire, Sint Eustatius and Saba - * `BA` - Bosnia and Herzegovina - * `BW` - Botswana - * `BV` - Bouvet Island - * `BR` - Brazil - * `IO` - British Indian Ocean Territory - * `BN` - Brunei - * `BG` - Bulgaria - * `BF` - Burkina Faso - * `BI` - Burundi - * `CV` - Cabo Verde - * `KH` - Cambodia - * `CM` - Cameroon - * `CA` - Canada - * `KY` - Cayman Islands - * `CF` - Central African Republic - * `TD` - Chad - * `CL` - Chile - * `CN` - China - * `CX` - Christmas Island - * `CC` - Cocos (Keeling) Islands - * `CO` - Colombia - * `KM` - Comoros - * `CG` - Congo - * `CD` - Congo (the Democratic Republic of the) - * `CK` - Cook Islands - * `CR` - Costa Rica - * `CI` - Côte d'Ivoire - * `HR` - Croatia - * `CU` - Cuba - * `CW` - Curaçao - * `CY` - Cyprus - * `CZ` - Czechia - * `DK` - Denmark - * `DJ` - Djibouti - * `DM` - Dominica - * `DO` - Dominican Republic - * `EC` - Ecuador - * `EG` - Egypt - * `SV` - El Salvador - * `GQ` - Equatorial Guinea - * `ER` - Eritrea - * `EE` - Estonia - * `SZ` - Eswatini - * `ET` - Ethiopia - * `FK` - Falkland Islands (Malvinas) - * `FO` - Faroe Islands - * `FJ` - Fiji - * `FI` - Finland - * `FR` - France - * `GF` - French Guiana - * `PF` - French Polynesia - * `TF` - French Southern Territories - * `GA` - Gabon - * `GM` - Gambia - * `GE` - Georgia - * `DE` - Germany - * `GH` - Ghana - * `GI` - Gibraltar - * `GR` - Greece - * `GL` - Greenland - * `GD` - Grenada - * `GP` - Guadeloupe - * `GU` - Guam - * `GT` - Guatemala - * `GG` - Guernsey - * `GN` - Guinea - * `GW` - Guinea-Bissau - * `GY` - Guyana - * `HT` - Haiti - * `HM` - Heard Island and McDonald Islands - * `VA` - Holy See - * `HN` - Honduras - * `HK` - Hong Kong - * `HU` - Hungary - * `IS` - Iceland - * `IN` - India - * `ID` - Indonesia - * `IR` - Iran - * `IQ` - Iraq - * `IE` - Ireland - * `IM` - Isle of Man - * `IL` - Israel - * `IT` - Italy - * `JM` - Jamaica - * `JP` - Japan - * `JE` - Jersey - * `JO` - Jordan - * `KZ` - Kazakhstan - * `KE` - Kenya - * `KI` - Kiribati - * `KW` - Kuwait - * `KG` - Kyrgyzstan - * `LA` - Laos - * `LV` - Latvia - * `LB` - Lebanon - * `LS` - Lesotho - * `LR` - Liberia - * `LY` - Libya - * `LI` - Liechtenstein - * `LT` - Lithuania - * `LU` - Luxembourg - * `MO` - Macao - * `MG` - Madagascar - * `MW` - Malawi - * `MY` - Malaysia - * `MV` - Maldives - * `ML` - Mali - * `MT` - Malta - * `MH` - Marshall Islands - * `MQ` - Martinique - * `MR` - Mauritania - * `MU` - Mauritius - * `YT` - Mayotte - * `MX` - Mexico - * `FM` - Micronesia (Federated States of) - * `MD` - Moldova - * `MC` - Monaco - * `MN` - Mongolia - * `ME` - Montenegro - * `MS` - Montserrat - * `MA` - Morocco - * `MZ` - Mozambique - * `MM` - Myanmar - * `NA` - Namibia - * `NR` - Nauru - * `NP` - Nepal - * `NL` - Netherlands - * `NC` - New Caledonia - * `NZ` - New Zealand - * `NI` - Nicaragua - * `NE` - Niger - * `NG` - Nigeria - * `NU` - Niue - * `NF` - Norfolk Island - * `KP` - North Korea - * `MK` - North Macedonia - * `MP` - Northern Mariana Islands - * `NO` - Norway - * `OM` - Oman - * `PK` - Pakistan - * `PW` - Palau - * `PS` - Palestine, State of - * `PA` - Panama - * `PG` - Papua New Guinea - * `PY` - Paraguay - * `PE` - Peru - * `PH` - Philippines - * `PN` - Pitcairn - * `PL` - Poland - * `PT` - Portugal - * `PR` - Puerto Rico - * `QA` - Qatar - * `RE` - Réunion - * `RO` - Romania - * `RU` - Russia - * `RW` - Rwanda - * `BL` - Saint Barthélemy - * `SH` - Saint Helena, Ascension and Tristan da Cunha - * `KN` - Saint Kitts and Nevis - * `LC` - Saint Lucia - * `MF` - Saint Martin (French part) - * `PM` - Saint Pierre and Miquelon - * `VC` - Saint Vincent and the Grenadines - * `WS` - Samoa - * `SM` - San Marino - * `ST` - Sao Tome and Principe - * `SA` - Saudi Arabia - * `SN` - Senegal - * `RS` - Serbia - * `SC` - Seychelles - * `SL` - Sierra Leone - * `SG` - Singapore - * `SX` - Sint Maarten (Dutch part) - * `SK` - Slovakia - * `SI` - Slovenia - * `SB` - Solomon Islands - * `SO` - Somalia - * `ZA` - South Africa - * `GS` - South Georgia and the South Sandwich Islands - * `KR` - South Korea - * `SS` - South Sudan - * `ES` - Spain - * `LK` - Sri Lanka - * `SD` - Sudan - * `SR` - Suriname - * `SJ` - Svalbard and Jan Mayen - * `SE` - Sweden - * `CH` - Switzerland - * `SY` - Syria - * `TW` - Taiwan - * `TJ` - Tajikistan - * `TZ` - Tanzania - * `TH` - Thailand - * `TL` - Timor-Leste - * `TG` - Togo - * `TK` - Tokelau - * `TO` - Tonga - * `TT` - Trinidad and Tobago - * `TN` - Tunisia - * `TR` - Turkey - * `TM` - Turkmenistan - * `TC` - Turks and Caicos Islands - * `TV` - Tuvalu - * `UG` - Uganda - * `UA` - Ukraine - * `AE` - United Arab Emirates - * `GB` - United Kingdom - * `UM` - United States Minor Outlying Islands - * `US` - United States of America - * `UY` - Uruguay - * `UZ` - Uzbekistan - * `VU` - Vanuatu - * `VE` - Venezuela - * `VN` - Vietnam - * `VG` - Virgin Islands (British) - * `VI` - Virgin Islands (U.S.) - * `WF` - Wallis and Futuna - * `EH` - Western Sahara - * `YE` - Yemen - * `ZM` - Zambia - * `ZW` - Zimbabwe - union: - - CountryEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - Address: - docs: >- - # The Address Object + * `DZD` - Algerian Dinar - ### Description + * `ADP` - Andorran Peseta - The `Address` object is used to represent a contact's or company's - address. + * `AOA` - Angolan Kwanza + * `AOK` - Angolan Kwanza (1977–1991) - ### Usage Example + * `AON` - Angolan New Kwanza (1990–2000) - Fetch from the `GET CompanyInfo` endpoint and view the company's - addresses. - properties: - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - type: - type: optional - docs: |- - The address type. + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `BILLING` - BILLING - * `SHIPPING` - SHIPPING - street_1: - type: optional - docs: Line 1 of the address's street. - street_2: - type: optional - docs: Line 2 of the address's street. - city: - type: optional - docs: The address's city. - state: - type: optional - access: read-only - country_subdivision: - type: optional - docs: The address's state or region. - country: - type: optional - docs: |- - The address's country. + * `ARA` - Argentine Austral - * `AF` - Afghanistan - * `AX` - Åland Islands - * `AL` - Albania - * `DZ` - Algeria - * `AS` - American Samoa - * `AD` - Andorra - * `AO` - Angola - * `AI` - Anguilla - * `AQ` - Antarctica - * `AG` - Antigua and Barbuda - * `AR` - Argentina - * `AM` - Armenia - * `AW` - Aruba - * `AU` - Australia - * `AT` - Austria - * `AZ` - Azerbaijan - * `BS` - Bahamas - * `BH` - Bahrain - * `BD` - Bangladesh - * `BB` - Barbados - * `BY` - Belarus - * `BE` - Belgium - * `BZ` - Belize - * `BJ` - Benin - * `BM` - Bermuda - * `BT` - Bhutan - * `BO` - Bolivia - * `BQ` - Bonaire, Sint Eustatius and Saba - * `BA` - Bosnia and Herzegovina - * `BW` - Botswana - * `BV` - Bouvet Island - * `BR` - Brazil - * `IO` - British Indian Ocean Territory - * `BN` - Brunei - * `BG` - Bulgaria - * `BF` - Burkina Faso - * `BI` - Burundi - * `CV` - Cabo Verde - * `KH` - Cambodia - * `CM` - Cameroon - * `CA` - Canada - * `KY` - Cayman Islands - * `CF` - Central African Republic - * `TD` - Chad - * `CL` - Chile - * `CN` - China - * `CX` - Christmas Island - * `CC` - Cocos (Keeling) Islands - * `CO` - Colombia - * `KM` - Comoros - * `CG` - Congo - * `CD` - Congo (the Democratic Republic of the) - * `CK` - Cook Islands - * `CR` - Costa Rica - * `CI` - Côte d'Ivoire - * `HR` - Croatia - * `CU` - Cuba - * `CW` - Curaçao - * `CY` - Cyprus - * `CZ` - Czechia - * `DK` - Denmark - * `DJ` - Djibouti - * `DM` - Dominica - * `DO` - Dominican Republic - * `EC` - Ecuador - * `EG` - Egypt - * `SV` - El Salvador - * `GQ` - Equatorial Guinea - * `ER` - Eritrea - * `EE` - Estonia - * `SZ` - Eswatini - * `ET` - Ethiopia - * `FK` - Falkland Islands (Malvinas) - * `FO` - Faroe Islands - * `FJ` - Fiji - * `FI` - Finland - * `FR` - France - * `GF` - French Guiana - * `PF` - French Polynesia - * `TF` - French Southern Territories - * `GA` - Gabon - * `GM` - Gambia - * `GE` - Georgia - * `DE` - Germany - * `GH` - Ghana - * `GI` - Gibraltar - * `GR` - Greece - * `GL` - Greenland - * `GD` - Grenada - * `GP` - Guadeloupe - * `GU` - Guam - * `GT` - Guatemala - * `GG` - Guernsey - * `GN` - Guinea - * `GW` - Guinea-Bissau - * `GY` - Guyana - * `HT` - Haiti - * `HM` - Heard Island and McDonald Islands - * `VA` - Holy See - * `HN` - Honduras - * `HK` - Hong Kong - * `HU` - Hungary - * `IS` - Iceland - * `IN` - India - * `ID` - Indonesia - * `IR` - Iran - * `IQ` - Iraq - * `IE` - Ireland - * `IM` - Isle of Man - * `IL` - Israel - * `IT` - Italy - * `JM` - Jamaica - * `JP` - Japan - * `JE` - Jersey - * `JO` - Jordan - * `KZ` - Kazakhstan - * `KE` - Kenya - * `KI` - Kiribati - * `KW` - Kuwait - * `KG` - Kyrgyzstan - * `LA` - Laos - * `LV` - Latvia - * `LB` - Lebanon - * `LS` - Lesotho - * `LR` - Liberia - * `LY` - Libya - * `LI` - Liechtenstein - * `LT` - Lithuania - * `LU` - Luxembourg - * `MO` - Macao - * `MG` - Madagascar - * `MW` - Malawi - * `MY` - Malaysia - * `MV` - Maldives - * `ML` - Mali - * `MT` - Malta - * `MH` - Marshall Islands - * `MQ` - Martinique - * `MR` - Mauritania - * `MU` - Mauritius - * `YT` - Mayotte - * `MX` - Mexico - * `FM` - Micronesia (Federated States of) - * `MD` - Moldova - * `MC` - Monaco - * `MN` - Mongolia - * `ME` - Montenegro - * `MS` - Montserrat - * `MA` - Morocco - * `MZ` - Mozambique - * `MM` - Myanmar - * `NA` - Namibia - * `NR` - Nauru - * `NP` - Nepal - * `NL` - Netherlands - * `NC` - New Caledonia - * `NZ` - New Zealand - * `NI` - Nicaragua - * `NE` - Niger - * `NG` - Nigeria - * `NU` - Niue - * `NF` - Norfolk Island - * `KP` - North Korea - * `MK` - North Macedonia - * `MP` - Northern Mariana Islands - * `NO` - Norway - * `OM` - Oman - * `PK` - Pakistan - * `PW` - Palau - * `PS` - Palestine, State of - * `PA` - Panama - * `PG` - Papua New Guinea - * `PY` - Paraguay - * `PE` - Peru - * `PH` - Philippines - * `PN` - Pitcairn - * `PL` - Poland - * `PT` - Portugal - * `PR` - Puerto Rico - * `QA` - Qatar - * `RE` - Réunion - * `RO` - Romania - * `RU` - Russia - * `RW` - Rwanda - * `BL` - Saint Barthélemy - * `SH` - Saint Helena, Ascension and Tristan da Cunha - * `KN` - Saint Kitts and Nevis - * `LC` - Saint Lucia - * `MF` - Saint Martin (French part) - * `PM` - Saint Pierre and Miquelon - * `VC` - Saint Vincent and the Grenadines - * `WS` - Samoa - * `SM` - San Marino - * `ST` - Sao Tome and Principe - * `SA` - Saudi Arabia - * `SN` - Senegal - * `RS` - Serbia - * `SC` - Seychelles - * `SL` - Sierra Leone - * `SG` - Singapore - * `SX` - Sint Maarten (Dutch part) - * `SK` - Slovakia - * `SI` - Slovenia - * `SB` - Solomon Islands - * `SO` - Somalia - * `ZA` - South Africa - * `GS` - South Georgia and the South Sandwich Islands - * `KR` - South Korea - * `SS` - South Sudan - * `ES` - Spain - * `LK` - Sri Lanka - * `SD` - Sudan - * `SR` - Suriname - * `SJ` - Svalbard and Jan Mayen - * `SE` - Sweden - * `CH` - Switzerland - * `SY` - Syria - * `TW` - Taiwan - * `TJ` - Tajikistan - * `TZ` - Tanzania - * `TH` - Thailand - * `TL` - Timor-Leste - * `TG` - Togo - * `TK` - Tokelau - * `TO` - Tonga - * `TT` - Trinidad and Tobago - * `TN` - Tunisia - * `TR` - Turkey - * `TM` - Turkmenistan - * `TC` - Turks and Caicos Islands - * `TV` - Tuvalu - * `UG` - Uganda - * `UA` - Ukraine - * `AE` - United Arab Emirates - * `GB` - United Kingdom - * `UM` - United States Minor Outlying Islands - * `US` - United States of America - * `UY` - Uruguay - * `UZ` - Uzbekistan - * `VU` - Vanuatu - * `VE` - Venezuela - * `VN` - Vietnam - * `VG` - Virgin Islands (British) - * `VI` - Virgin Islands (U.S.) - * `WF` - Wallis and Futuna - * `EH` - Western Sahara - * `YE` - Yemen - * `ZM` - Zambia - * `ZW` - Zimbabwe - zip_code: - type: optional - docs: The address's zip code. - source: - openapi: openapi/openapi.yml - AddressRequestType: - discriminated: false - docs: |- - The address type. + * `ARS` - Argentine Peso - * `BILLING` - BILLING - * `SHIPPING` - SHIPPING - union: - - AddressTypeEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - AddressRequestCountry: - discriminated: false - docs: |- - The address's country. + * `ARM` - Argentine Peso (1881–1970) - * `AF` - Afghanistan - * `AX` - Åland Islands - * `AL` - Albania - * `DZ` - Algeria - * `AS` - American Samoa - * `AD` - Andorra - * `AO` - Angola - * `AI` - Anguilla - * `AQ` - Antarctica - * `AG` - Antigua and Barbuda - * `AR` - Argentina - * `AM` - Armenia - * `AW` - Aruba - * `AU` - Australia - * `AT` - Austria - * `AZ` - Azerbaijan - * `BS` - Bahamas - * `BH` - Bahrain - * `BD` - Bangladesh - * `BB` - Barbados - * `BY` - Belarus - * `BE` - Belgium - * `BZ` - Belize - * `BJ` - Benin - * `BM` - Bermuda - * `BT` - Bhutan - * `BO` - Bolivia - * `BQ` - Bonaire, Sint Eustatius and Saba - * `BA` - Bosnia and Herzegovina - * `BW` - Botswana - * `BV` - Bouvet Island - * `BR` - Brazil - * `IO` - British Indian Ocean Territory - * `BN` - Brunei - * `BG` - Bulgaria - * `BF` - Burkina Faso - * `BI` - Burundi - * `CV` - Cabo Verde - * `KH` - Cambodia - * `CM` - Cameroon - * `CA` - Canada - * `KY` - Cayman Islands - * `CF` - Central African Republic - * `TD` - Chad - * `CL` - Chile - * `CN` - China - * `CX` - Christmas Island - * `CC` - Cocos (Keeling) Islands - * `CO` - Colombia - * `KM` - Comoros - * `CG` - Congo - * `CD` - Congo (the Democratic Republic of the) - * `CK` - Cook Islands - * `CR` - Costa Rica - * `CI` - Côte d'Ivoire - * `HR` - Croatia - * `CU` - Cuba - * `CW` - Curaçao - * `CY` - Cyprus - * `CZ` - Czechia - * `DK` - Denmark - * `DJ` - Djibouti - * `DM` - Dominica - * `DO` - Dominican Republic - * `EC` - Ecuador - * `EG` - Egypt - * `SV` - El Salvador - * `GQ` - Equatorial Guinea - * `ER` - Eritrea - * `EE` - Estonia - * `SZ` - Eswatini - * `ET` - Ethiopia - * `FK` - Falkland Islands (Malvinas) - * `FO` - Faroe Islands - * `FJ` - Fiji - * `FI` - Finland - * `FR` - France - * `GF` - French Guiana - * `PF` - French Polynesia - * `TF` - French Southern Territories - * `GA` - Gabon - * `GM` - Gambia - * `GE` - Georgia - * `DE` - Germany - * `GH` - Ghana - * `GI` - Gibraltar - * `GR` - Greece - * `GL` - Greenland - * `GD` - Grenada - * `GP` - Guadeloupe - * `GU` - Guam - * `GT` - Guatemala - * `GG` - Guernsey - * `GN` - Guinea - * `GW` - Guinea-Bissau - * `GY` - Guyana - * `HT` - Haiti - * `HM` - Heard Island and McDonald Islands - * `VA` - Holy See - * `HN` - Honduras - * `HK` - Hong Kong - * `HU` - Hungary - * `IS` - Iceland - * `IN` - India - * `ID` - Indonesia - * `IR` - Iran - * `IQ` - Iraq - * `IE` - Ireland - * `IM` - Isle of Man - * `IL` - Israel - * `IT` - Italy - * `JM` - Jamaica - * `JP` - Japan - * `JE` - Jersey - * `JO` - Jordan - * `KZ` - Kazakhstan - * `KE` - Kenya - * `KI` - Kiribati - * `KW` - Kuwait - * `KG` - Kyrgyzstan - * `LA` - Laos - * `LV` - Latvia - * `LB` - Lebanon - * `LS` - Lesotho - * `LR` - Liberia - * `LY` - Libya - * `LI` - Liechtenstein - * `LT` - Lithuania - * `LU` - Luxembourg - * `MO` - Macao - * `MG` - Madagascar - * `MW` - Malawi - * `MY` - Malaysia - * `MV` - Maldives - * `ML` - Mali - * `MT` - Malta - * `MH` - Marshall Islands - * `MQ` - Martinique - * `MR` - Mauritania - * `MU` - Mauritius - * `YT` - Mayotte - * `MX` - Mexico - * `FM` - Micronesia (Federated States of) - * `MD` - Moldova - * `MC` - Monaco - * `MN` - Mongolia - * `ME` - Montenegro - * `MS` - Montserrat - * `MA` - Morocco - * `MZ` - Mozambique - * `MM` - Myanmar - * `NA` - Namibia - * `NR` - Nauru - * `NP` - Nepal - * `NL` - Netherlands - * `NC` - New Caledonia - * `NZ` - New Zealand - * `NI` - Nicaragua - * `NE` - Niger - * `NG` - Nigeria - * `NU` - Niue - * `NF` - Norfolk Island - * `KP` - North Korea - * `MK` - North Macedonia - * `MP` - Northern Mariana Islands - * `NO` - Norway - * `OM` - Oman - * `PK` - Pakistan - * `PW` - Palau - * `PS` - Palestine, State of - * `PA` - Panama - * `PG` - Papua New Guinea - * `PY` - Paraguay - * `PE` - Peru - * `PH` - Philippines - * `PN` - Pitcairn - * `PL` - Poland - * `PT` - Portugal - * `PR` - Puerto Rico - * `QA` - Qatar - * `RE` - Réunion - * `RO` - Romania - * `RU` - Russia - * `RW` - Rwanda - * `BL` - Saint Barthélemy - * `SH` - Saint Helena, Ascension and Tristan da Cunha - * `KN` - Saint Kitts and Nevis - * `LC` - Saint Lucia - * `MF` - Saint Martin (French part) - * `PM` - Saint Pierre and Miquelon - * `VC` - Saint Vincent and the Grenadines - * `WS` - Samoa - * `SM` - San Marino - * `ST` - Sao Tome and Principe - * `SA` - Saudi Arabia - * `SN` - Senegal - * `RS` - Serbia - * `SC` - Seychelles - * `SL` - Sierra Leone - * `SG` - Singapore - * `SX` - Sint Maarten (Dutch part) - * `SK` - Slovakia - * `SI` - Slovenia - * `SB` - Solomon Islands - * `SO` - Somalia - * `ZA` - South Africa - * `GS` - South Georgia and the South Sandwich Islands - * `KR` - South Korea - * `SS` - South Sudan - * `ES` - Spain - * `LK` - Sri Lanka - * `SD` - Sudan - * `SR` - Suriname - * `SJ` - Svalbard and Jan Mayen - * `SE` - Sweden - * `CH` - Switzerland - * `SY` - Syria - * `TW` - Taiwan - * `TJ` - Tajikistan - * `TZ` - Tanzania - * `TH` - Thailand - * `TL` - Timor-Leste - * `TG` - Togo - * `TK` - Tokelau - * `TO` - Tonga - * `TT` - Trinidad and Tobago - * `TN` - Tunisia - * `TR` - Turkey - * `TM` - Turkmenistan - * `TC` - Turks and Caicos Islands - * `TV` - Tuvalu - * `UG` - Uganda - * `UA` - Ukraine - * `AE` - United Arab Emirates - * `GB` - United Kingdom - * `UM` - United States Minor Outlying Islands - * `US` - United States of America - * `UY` - Uruguay - * `UZ` - Uzbekistan - * `VU` - Vanuatu - * `VE` - Venezuela - * `VN` - Vietnam - * `VG` - Virgin Islands (British) - * `VI` - Virgin Islands (U.S.) - * `WF` - Wallis and Futuna - * `EH` - Western Sahara - * `YE` - Yemen - * `ZM` - Zambia - * `ZW` - Zimbabwe - union: - - CountryEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - AddressRequest: - docs: >- - # The Address Object + * `ARP` - Argentine Peso (1983–1985) - ### Description + * `ARL` - Argentine Peso Ley (1970–1983) - The `Address` object is used to represent a contact's or company's - address. + * `AMD` - Armenian Dram + * `AWG` - Aruban Florin - ### Usage Example + * `AUD` - Australian Dollar - Fetch from the `GET CompanyInfo` endpoint and view the company's - addresses. - properties: - type: - type: optional - docs: |- - The address type. + * `ATS` - Austrian Schilling - * `BILLING` - BILLING - * `SHIPPING` - SHIPPING - street_1: - type: optional - docs: Line 1 of the address's street. - street_2: - type: optional - docs: Line 2 of the address's street. - city: - type: optional - docs: The address's city. - country_subdivision: - type: optional - docs: The address's state or region. - country: - type: optional - docs: |- - The address's country. + * `AZN` - Azerbaijani Manat - * `AF` - Afghanistan - * `AX` - Åland Islands - * `AL` - Albania - * `DZ` - Algeria - * `AS` - American Samoa - * `AD` - Andorra - * `AO` - Angola - * `AI` - Anguilla - * `AQ` - Antarctica - * `AG` - Antigua and Barbuda - * `AR` - Argentina - * `AM` - Armenia - * `AW` - Aruba - * `AU` - Australia - * `AT` - Austria - * `AZ` - Azerbaijan - * `BS` - Bahamas - * `BH` - Bahrain - * `BD` - Bangladesh - * `BB` - Barbados - * `BY` - Belarus - * `BE` - Belgium - * `BZ` - Belize - * `BJ` - Benin - * `BM` - Bermuda - * `BT` - Bhutan - * `BO` - Bolivia - * `BQ` - Bonaire, Sint Eustatius and Saba - * `BA` - Bosnia and Herzegovina - * `BW` - Botswana - * `BV` - Bouvet Island - * `BR` - Brazil - * `IO` - British Indian Ocean Territory - * `BN` - Brunei - * `BG` - Bulgaria - * `BF` - Burkina Faso - * `BI` - Burundi - * `CV` - Cabo Verde - * `KH` - Cambodia - * `CM` - Cameroon - * `CA` - Canada - * `KY` - Cayman Islands - * `CF` - Central African Republic - * `TD` - Chad - * `CL` - Chile - * `CN` - China - * `CX` - Christmas Island - * `CC` - Cocos (Keeling) Islands - * `CO` - Colombia - * `KM` - Comoros - * `CG` - Congo - * `CD` - Congo (the Democratic Republic of the) - * `CK` - Cook Islands - * `CR` - Costa Rica - * `CI` - Côte d'Ivoire - * `HR` - Croatia - * `CU` - Cuba - * `CW` - Curaçao - * `CY` - Cyprus - * `CZ` - Czechia - * `DK` - Denmark - * `DJ` - Djibouti - * `DM` - Dominica - * `DO` - Dominican Republic - * `EC` - Ecuador - * `EG` - Egypt - * `SV` - El Salvador - * `GQ` - Equatorial Guinea - * `ER` - Eritrea - * `EE` - Estonia - * `SZ` - Eswatini - * `ET` - Ethiopia - * `FK` - Falkland Islands (Malvinas) - * `FO` - Faroe Islands - * `FJ` - Fiji - * `FI` - Finland - * `FR` - France - * `GF` - French Guiana - * `PF` - French Polynesia - * `TF` - French Southern Territories - * `GA` - Gabon - * `GM` - Gambia - * `GE` - Georgia - * `DE` - Germany - * `GH` - Ghana - * `GI` - Gibraltar - * `GR` - Greece - * `GL` - Greenland - * `GD` - Grenada - * `GP` - Guadeloupe - * `GU` - Guam - * `GT` - Guatemala - * `GG` - Guernsey - * `GN` - Guinea - * `GW` - Guinea-Bissau - * `GY` - Guyana - * `HT` - Haiti - * `HM` - Heard Island and McDonald Islands - * `VA` - Holy See - * `HN` - Honduras - * `HK` - Hong Kong - * `HU` - Hungary - * `IS` - Iceland - * `IN` - India - * `ID` - Indonesia - * `IR` - Iran - * `IQ` - Iraq - * `IE` - Ireland - * `IM` - Isle of Man - * `IL` - Israel - * `IT` - Italy - * `JM` - Jamaica - * `JP` - Japan - * `JE` - Jersey - * `JO` - Jordan - * `KZ` - Kazakhstan - * `KE` - Kenya - * `KI` - Kiribati - * `KW` - Kuwait - * `KG` - Kyrgyzstan - * `LA` - Laos - * `LV` - Latvia - * `LB` - Lebanon - * `LS` - Lesotho - * `LR` - Liberia - * `LY` - Libya - * `LI` - Liechtenstein - * `LT` - Lithuania - * `LU` - Luxembourg - * `MO` - Macao - * `MG` - Madagascar - * `MW` - Malawi - * `MY` - Malaysia - * `MV` - Maldives - * `ML` - Mali - * `MT` - Malta - * `MH` - Marshall Islands - * `MQ` - Martinique - * `MR` - Mauritania - * `MU` - Mauritius - * `YT` - Mayotte - * `MX` - Mexico - * `FM` - Micronesia (Federated States of) - * `MD` - Moldova - * `MC` - Monaco - * `MN` - Mongolia - * `ME` - Montenegro - * `MS` - Montserrat - * `MA` - Morocco - * `MZ` - Mozambique - * `MM` - Myanmar - * `NA` - Namibia - * `NR` - Nauru - * `NP` - Nepal - * `NL` - Netherlands - * `NC` - New Caledonia - * `NZ` - New Zealand - * `NI` - Nicaragua - * `NE` - Niger - * `NG` - Nigeria - * `NU` - Niue - * `NF` - Norfolk Island - * `KP` - North Korea - * `MK` - North Macedonia - * `MP` - Northern Mariana Islands - * `NO` - Norway - * `OM` - Oman - * `PK` - Pakistan - * `PW` - Palau - * `PS` - Palestine, State of - * `PA` - Panama - * `PG` - Papua New Guinea - * `PY` - Paraguay - * `PE` - Peru - * `PH` - Philippines - * `PN` - Pitcairn - * `PL` - Poland - * `PT` - Portugal - * `PR` - Puerto Rico - * `QA` - Qatar - * `RE` - Réunion - * `RO` - Romania - * `RU` - Russia - * `RW` - Rwanda - * `BL` - Saint Barthélemy - * `SH` - Saint Helena, Ascension and Tristan da Cunha - * `KN` - Saint Kitts and Nevis - * `LC` - Saint Lucia - * `MF` - Saint Martin (French part) - * `PM` - Saint Pierre and Miquelon - * `VC` - Saint Vincent and the Grenadines - * `WS` - Samoa - * `SM` - San Marino - * `ST` - Sao Tome and Principe - * `SA` - Saudi Arabia - * `SN` - Senegal - * `RS` - Serbia - * `SC` - Seychelles - * `SL` - Sierra Leone - * `SG` - Singapore - * `SX` - Sint Maarten (Dutch part) - * `SK` - Slovakia - * `SI` - Slovenia - * `SB` - Solomon Islands - * `SO` - Somalia - * `ZA` - South Africa - * `GS` - South Georgia and the South Sandwich Islands - * `KR` - South Korea - * `SS` - South Sudan - * `ES` - Spain - * `LK` - Sri Lanka - * `SD` - Sudan - * `SR` - Suriname - * `SJ` - Svalbard and Jan Mayen - * `SE` - Sweden - * `CH` - Switzerland - * `SY` - Syria - * `TW` - Taiwan - * `TJ` - Tajikistan - * `TZ` - Tanzania - * `TH` - Thailand - * `TL` - Timor-Leste - * `TG` - Togo - * `TK` - Tokelau - * `TO` - Tonga - * `TT` - Trinidad and Tobago - * `TN` - Tunisia - * `TR` - Turkey - * `TM` - Turkmenistan - * `TC` - Turks and Caicos Islands - * `TV` - Tuvalu - * `UG` - Uganda - * `UA` - Ukraine - * `AE` - United Arab Emirates - * `GB` - United Kingdom - * `UM` - United States Minor Outlying Islands - * `US` - United States of America - * `UY` - Uruguay - * `UZ` - Uzbekistan - * `VU` - Vanuatu - * `VE` - Venezuela - * `VN` - Vietnam - * `VG` - Virgin Islands (British) - * `VI` - Virgin Islands (U.S.) - * `WF` - Wallis and Futuna - * `EH` - Western Sahara - * `YE` - Yemen - * `ZM` - Zambia - * `ZW` - Zimbabwe - zip_code: - type: optional - docs: The address's zip code. - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - AddressTypeEnum: - enum: - - BILLING - - SHIPPING - docs: |- - * `BILLING` - BILLING - * `SHIPPING` - SHIPPING - source: - openapi: openapi/openapi.yml - AdvancedMetadata: - properties: - id: - type: string - validation: - format: uuid - display_name: optional - description: optional - is_required: optional - is_custom: optional - field_choices: optional> - source: - openapi: openapi/openapi.yml - AsyncPassthroughReciept: - properties: - async_passthrough_receipt_id: - type: string - validation: - format: uuid - source: - openapi: openapi/openapi.yml - AsyncPostTaskStatus: - discriminated: false - union: - - AsyncPostTaskStatusEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - AsyncPostTask: - properties: - status: AsyncPostTaskStatus - result: AsyncPostTaskResult - source: - openapi: openapi/openapi.yml - AsyncPostTaskResult: - properties: - status_code: optional - response: optional> - source: - openapi: openapi/openapi.yml - AsyncPostTaskStatusEnum: - enum: - - QUEUED - - IN_PROGRESS - - COMPLETED - - FAILURE - docs: |- - * `QUEUED` - QUEUED - * `IN_PROGRESS` - IN_PROGRESS - * `COMPLETED` - COMPLETED - * `FAILURE` - FAILURE - source: - openapi: openapi/openapi.yml - AuditLogEventRole: - discriminated: false - docs: >- - Designates the role of the user (or SYSTEM/API if action not taken by a - user) at the time of this Event occurring. + * `AZM` - Azerbaijani Manat (1993–2006) + * `BSD` - Bahamian Dollar - * `ADMIN` - ADMIN + * `BHD` - Bahraini Dinar - * `DEVELOPER` - DEVELOPER + * `BDT` - Bangladeshi Taka - * `MEMBER` - MEMBER + * `BBD` - Barbadian Dollar - * `API` - API + * `BYN` - Belarusian Ruble - * `SYSTEM` - SYSTEM + * `BYB` - Belarusian Ruble (1994–1999) - * `MERGE_TEAM` - MERGE_TEAM - union: - - RoleEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - AuditLogEventEventType: - discriminated: false - docs: >- - Designates the type of event that occurred. + * `BYR` - Belarusian Ruble (2000–2016) + * `BEF` - Belgian Franc - * `CREATED_REMOTE_PRODUCTION_API_KEY` - CREATED_REMOTE_PRODUCTION_API_KEY + * `BEC` - Belgian Franc (convertible) - * `DELETED_REMOTE_PRODUCTION_API_KEY` - DELETED_REMOTE_PRODUCTION_API_KEY + * `BEL` - Belgian Franc (financial) - * `CREATED_TEST_API_KEY` - CREATED_TEST_API_KEY + * `BZD` - Belize Dollar - * `DELETED_TEST_API_KEY` - DELETED_TEST_API_KEY + * `BMD` - Bermudan Dollar - * `REGENERATED_PRODUCTION_API_KEY` - REGENERATED_PRODUCTION_API_KEY + * `BTN` - Bhutanese Ngultrum - * `REGENERATED_WEBHOOK_SIGNATURE` - REGENERATED_WEBHOOK_SIGNATURE + * `BOB` - Bolivian Boliviano - * `INVITED_USER` - INVITED_USER + * `BOL` - Bolivian Boliviano (1863–1963) - * `TWO_FACTOR_AUTH_ENABLED` - TWO_FACTOR_AUTH_ENABLED + * `BOV` - Bolivian Mvdol - * `TWO_FACTOR_AUTH_DISABLED` - TWO_FACTOR_AUTH_DISABLED + * `BOP` - Bolivian Peso - * `DELETED_LINKED_ACCOUNT` - DELETED_LINKED_ACCOUNT + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT` - - DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `CREATED_DESTINATION` - CREATED_DESTINATION + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `DELETED_DESTINATION` - DELETED_DESTINATION + * `BWP` - Botswanan Pula - * `CHANGED_DESTINATION` - CHANGED_DESTINATION + * `BRC` - Brazilian Cruzado (1986–1989) - * `CHANGED_SCOPES` - CHANGED_SCOPES + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `CHANGED_PERSONAL_INFORMATION` - CHANGED_PERSONAL_INFORMATION + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `CHANGED_ORGANIZATION_SETTINGS` - CHANGED_ORGANIZATION_SETTINGS + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `ENABLED_INTEGRATION` - ENABLED_INTEGRATION + * `BRN` - Brazilian New Cruzado (1989–1990) - * `DISABLED_INTEGRATION` - DISABLED_INTEGRATION + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `ENABLED_CATEGORY` - ENABLED_CATEGORY + * `BRL` - Brazilian Real - * `DISABLED_CATEGORY` - DISABLED_CATEGORY + * `GBP` - British Pound - * `CHANGED_PASSWORD` - CHANGED_PASSWORD + * `BND` - Brunei Dollar - * `RESET_PASSWORD` - RESET_PASSWORD + * `BGL` - Bulgarian Hard Lev - * `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - - ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION + * `BGN` - Bulgarian Lev - * `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - - ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT + * `BGO` - Bulgarian Lev (1879–1952) - * `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - - DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION + * `BGM` - Bulgarian Socialist Lev - * `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - - DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT + * `BUK` - Burmese Kyat - * `CREATED_INTEGRATION_WIDE_FIELD_MAPPING` - - CREATED_INTEGRATION_WIDE_FIELD_MAPPING + * `BIF` - Burundian Franc - * `CREATED_LINKED_ACCOUNT_FIELD_MAPPING` - - CREATED_LINKED_ACCOUNT_FIELD_MAPPING + * `XPF` - CFP Franc - * `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING` - - CHANGED_INTEGRATION_WIDE_FIELD_MAPPING + * `KHR` - Cambodian Riel - * `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING` - - CHANGED_LINKED_ACCOUNT_FIELD_MAPPING + * `CAD` - Canadian Dollar - * `DELETED_INTEGRATION_WIDE_FIELD_MAPPING` - - DELETED_INTEGRATION_WIDE_FIELD_MAPPING + * `CVE` - Cape Verdean Escudo - * `DELETED_LINKED_ACCOUNT_FIELD_MAPPING` - - DELETED_LINKED_ACCOUNT_FIELD_MAPPING + * `KYD` - Cayman Islands Dollar - * `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - - CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE + * `XAF` - Central African CFA Franc - * `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - - CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE + * `CLE` - Chilean Escudo - * `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - - DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE + * `CLP` - Chilean Peso - * `FORCED_LINKED_ACCOUNT_RESYNC` - FORCED_LINKED_ACCOUNT_RESYNC + * `CLF` - Chilean Unit of Account (UF) - * `MUTED_ISSUE` - MUTED_ISSUE + * `CNX` - Chinese People’s Bank Dollar - * `GENERATED_MAGIC_LINK` - GENERATED_MAGIC_LINK + * `CNY` - Chinese Yuan - * `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK + * `CNH` - Chinese Yuan (offshore) - * `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK + * `COP` - Colombian Peso - * `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED + * `COU` - Colombian Real Value Unit - * `END_USER_CREDENTIALS_ACCESSED` - END_USER_CREDENTIALS_ACCESSED - union: - - EventTypeEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - AuditLogEvent: - properties: - id: - type: optional - validation: - format: uuid - access: read-only - user_name: - type: optional - docs: The User's full name at the time of this Event occurring. - validation: - maxLength: 200 - user_email: - type: optional - docs: The User's email at the time of this Event occurring. - validation: - format: email - maxLength: 254 - role: - type: AuditLogEventRole - docs: >- - Designates the role of the user (or SYSTEM/API if action not taken by - a user) at the time of this Event occurring. + * `KMF` - Comorian Franc + * `CDF` - Congolese Franc - * `ADMIN` - ADMIN + * `CRC` - Costa Rican Colón - * `DEVELOPER` - DEVELOPER + * `HRD` - Croatian Dinar - * `MEMBER` - MEMBER + * `HRK` - Croatian Kuna - * `API` - API + * `CUC` - Cuban Convertible Peso - * `SYSTEM` - SYSTEM + * `CUP` - Cuban Peso - * `MERGE_TEAM` - MERGE_TEAM - ip_address: - type: string - validation: - maxLength: 45 - event_type: - type: AuditLogEventEventType - docs: >- - Designates the type of event that occurred. + * `CYP` - Cypriot Pound + * `CZK` - Czech Koruna - * `CREATED_REMOTE_PRODUCTION_API_KEY` - - CREATED_REMOTE_PRODUCTION_API_KEY + * `CSK` - Czechoslovak Hard Koruna - * `DELETED_REMOTE_PRODUCTION_API_KEY` - - DELETED_REMOTE_PRODUCTION_API_KEY + * `DKK` - Danish Krone - * `CREATED_TEST_API_KEY` - CREATED_TEST_API_KEY + * `DJF` - Djiboutian Franc - * `DELETED_TEST_API_KEY` - DELETED_TEST_API_KEY + * `DOP` - Dominican Peso - * `REGENERATED_PRODUCTION_API_KEY` - REGENERATED_PRODUCTION_API_KEY + * `NLG` - Dutch Guilder - * `REGENERATED_WEBHOOK_SIGNATURE` - REGENERATED_WEBHOOK_SIGNATURE + * `XCD` - East Caribbean Dollar - * `INVITED_USER` - INVITED_USER + * `DDM` - East German Mark - * `TWO_FACTOR_AUTH_ENABLED` - TWO_FACTOR_AUTH_ENABLED + * `ECS` - Ecuadorian Sucre - * `TWO_FACTOR_AUTH_DISABLED` - TWO_FACTOR_AUTH_DISABLED + * `ECV` - Ecuadorian Unit of Constant Value - * `DELETED_LINKED_ACCOUNT` - DELETED_LINKED_ACCOUNT + * `EGP` - Egyptian Pound - * `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT` - - DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT + * `GQE` - Equatorial Guinean Ekwele - * `CREATED_DESTINATION` - CREATED_DESTINATION + * `ERN` - Eritrean Nakfa - * `DELETED_DESTINATION` - DELETED_DESTINATION + * `EEK` - Estonian Kroon - * `CHANGED_DESTINATION` - CHANGED_DESTINATION + * `ETB` - Ethiopian Birr - * `CHANGED_SCOPES` - CHANGED_SCOPES + * `EUR` - Euro - * `CHANGED_PERSONAL_INFORMATION` - CHANGED_PERSONAL_INFORMATION + * `XBA` - European Composite Unit - * `CHANGED_ORGANIZATION_SETTINGS` - CHANGED_ORGANIZATION_SETTINGS + * `XEU` - European Currency Unit - * `ENABLED_INTEGRATION` - ENABLED_INTEGRATION + * `XBB` - European Monetary Unit - * `DISABLED_INTEGRATION` - DISABLED_INTEGRATION + * `XBC` - European Unit of Account (XBC) - * `ENABLED_CATEGORY` - ENABLED_CATEGORY + * `XBD` - European Unit of Account (XBD) - * `DISABLED_CATEGORY` - DISABLED_CATEGORY + * `FKP` - Falkland Islands Pound - * `CHANGED_PASSWORD` - CHANGED_PASSWORD + * `FJD` - Fijian Dollar - * `RESET_PASSWORD` - RESET_PASSWORD + * `FIM` - Finnish Markka - * `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - - ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION + * `FRF` - French Franc - * `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - - ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT + * `XFO` - French Gold Franc - * `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - - DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION + * `XFU` - French UIC-Franc - * `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - - DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT + * `GMD` - Gambian Dalasi - * `CREATED_INTEGRATION_WIDE_FIELD_MAPPING` - - CREATED_INTEGRATION_WIDE_FIELD_MAPPING + * `GEK` - Georgian Kupon Larit - * `CREATED_LINKED_ACCOUNT_FIELD_MAPPING` - - CREATED_LINKED_ACCOUNT_FIELD_MAPPING + * `GEL` - Georgian Lari - * `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING` - - CHANGED_INTEGRATION_WIDE_FIELD_MAPPING + * `DEM` - German Mark - * `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING` - - CHANGED_LINKED_ACCOUNT_FIELD_MAPPING + * `GHS` - Ghanaian Cedi - * `DELETED_INTEGRATION_WIDE_FIELD_MAPPING` - - DELETED_INTEGRATION_WIDE_FIELD_MAPPING + * `GHC` - Ghanaian Cedi (1979–2007) - * `DELETED_LINKED_ACCOUNT_FIELD_MAPPING` - - DELETED_LINKED_ACCOUNT_FIELD_MAPPING + * `GIP` - Gibraltar Pound - * `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - - CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE + * `XAU` - Gold - * `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - - CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE + * `GRD` - Greek Drachma - * `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - - DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE + * `GTQ` - Guatemalan Quetzal - * `FORCED_LINKED_ACCOUNT_RESYNC` - FORCED_LINKED_ACCOUNT_RESYNC + * `GWP` - Guinea-Bissau Peso - * `MUTED_ISSUE` - MUTED_ISSUE + * `GNF` - Guinean Franc - * `GENERATED_MAGIC_LINK` - GENERATED_MAGIC_LINK + * `GNS` - Guinean Syli - * `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK + * `GYD` - Guyanaese Dollar - * `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK + * `HTG` - Haitian Gourde - * `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED + * `HNL` - Honduran Lempira - * `END_USER_CREDENTIALS_ACCESSED` - END_USER_CREDENTIALS_ACCESSED - event_description: string - created_at: - type: optional - access: read-only - source: - openapi: openapi/openapi.yml - AvailableActions: - docs: >- - # The AvailableActions Object + * `HKD` - Hong Kong Dollar - ### Description + * `HUF` - Hungarian Forint - The `Activity` object is used to see all available model/operation - combinations for an integration. + * `IMP` - IMP + * `ISK` - Icelandic Króna - ### Usage Example + * `ISJ` - Icelandic Króna (1918–1981) - Fetch all the actions available for the `Zenefits` integration. - properties: - integration: AccountIntegration - passthrough_available: boolean - available_model_operations: optional> - source: - openapi: openapi/openapi.yml - BalanceSheetCurrency: - discriminated: false - docs: >- - The balance sheet's currency. + * `INR` - Indian Rupee + * `IDR` - Indonesian Rupiah - * `XUA` - ADB Unit of Account + * `IRR` - Iranian Rial - * `AFN` - Afghan Afghani + * `IQD` - Iraqi Dinar - * `AFA` - Afghan Afghani (1927–2002) + * `IEP` - Irish Pound - * `ALL` - Albanian Lek + * `ILS` - Israeli New Shekel - * `ALK` - Albanian Lek (1946–1965) + * `ILP` - Israeli Pound - * `DZD` - Algerian Dinar + * `ILR` - Israeli Shekel (1980–1985) - * `ADP` - Andorran Peseta + * `ITL` - Italian Lira - * `AOA` - Angolan Kwanza + * `JMD` - Jamaican Dollar - * `AOK` - Angolan Kwanza (1977–1991) + * `JPY` - Japanese Yen - * `AON` - Angolan New Kwanza (1990–2000) + * `JOD` - Jordanian Dinar - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `KZT` - Kazakhstani Tenge - * `ARA` - Argentine Austral + * `KES` - Kenyan Shilling - * `ARS` - Argentine Peso + * `KWD` - Kuwaiti Dinar - * `ARM` - Argentine Peso (1881–1970) + * `KGS` - Kyrgystani Som - * `ARP` - Argentine Peso (1983–1985) + * `LAK` - Laotian Kip - * `ARL` - Argentine Peso Ley (1970–1983) + * `LVL` - Latvian Lats + + * `LVR` - Latvian Ruble + + * `LBP` - Lebanese Pound + + * `LSL` - Lesotho Loti + + * `LRD` - Liberian Dollar + + * `LYD` - Libyan Dinar + + * `LTL` - Lithuanian Litas + + * `LTT` - Lithuanian Talonas + + * `LUL` - Luxembourg Financial Franc + + * `LUC` - Luxembourgian Convertible Franc + + * `LUF` - Luxembourgian Franc + + * `MOP` - Macanese Pataca + + * `MKD` - Macedonian Denar + + * `MKN` - Macedonian Denar (1992–1993) + + * `MGA` - Malagasy Ariary + + * `MGF` - Malagasy Franc + + * `MWK` - Malawian Kwacha + + * `MYR` - Malaysian Ringgit + + * `MVR` - Maldivian Rufiyaa + + * `MVP` - Maldivian Rupee (1947–1981) + + * `MLF` - Malian Franc + + * `MTL` - Maltese Lira + + * `MTP` - Maltese Pound + + * `MRU` - Mauritanian Ouguiya + + * `MRO` - Mauritanian Ouguiya (1973–2017) + + * `MUR` - Mauritian Rupee + + * `MXV` - Mexican Investment Unit + + * `MXN` - Mexican Peso + + * `MXP` - Mexican Silver Peso (1861–1992) + + * `MDC` - Moldovan Cupon + + * `MDL` - Moldovan Leu + + * `MCF` - Monegasque Franc + + * `MNT` - Mongolian Tugrik + + * `MAD` - Moroccan Dirham + + * `MAF` - Moroccan Franc + + * `MZE` - Mozambican Escudo + + * `MZN` - Mozambican Metical + + * `MZM` - Mozambican Metical (1980–2006) + + * `MMK` - Myanmar Kyat + + * `NAD` - Namibian Dollar + + * `NPR` - Nepalese Rupee + + * `ANG` - Netherlands Antillean Guilder + + * `TWD` - New Taiwan Dollar + + * `NZD` - New Zealand Dollar + + * `NIO` - Nicaraguan Córdoba + + * `NIC` - Nicaraguan Córdoba (1988–1991) + + * `NGN` - Nigerian Naira + + * `KPW` - North Korean Won + + * `NOK` - Norwegian Krone + + * `OMR` - Omani Rial + + * `PKR` - Pakistani Rupee + + * `XPD` - Palladium + + * `PAB` - Panamanian Balboa + + * `PGK` - Papua New Guinean Kina + + * `PYG` - Paraguayan Guarani + + * `PEI` - Peruvian Inti + + * `PEN` - Peruvian Sol + + * `PES` - Peruvian Sol (1863–1965) + + * `PHP` - Philippine Peso + + * `XPT` - Platinum + + * `PLN` - Polish Zloty + + * `PLZ` - Polish Zloty (1950–1995) + + * `PTE` - Portuguese Escudo + + * `GWE` - Portuguese Guinea Escudo + + * `QAR` - Qatari Rial + + * `XRE` - RINET Funds + + * `RHD` - Rhodesian Dollar + + * `RON` - Romanian Leu + + * `ROL` - Romanian Leu (1952–2006) + + * `RUB` - Russian Ruble + + * `RUR` - Russian Ruble (1991–1998) + + * `RWF` - Rwandan Franc + + * `SVC` - Salvadoran Colón + + * `WST` - Samoan Tala + + * `SAR` - Saudi Riyal + + * `RSD` - Serbian Dinar + + * `CSD` - Serbian Dinar (2002–2006) + + * `SCR` - Seychellois Rupee + + * `SLL` - Sierra Leonean Leone + + * `XAG` - Silver + + * `SGD` - Singapore Dollar + + * `SKK` - Slovak Koruna + + * `SIT` - Slovenian Tolar + + * `SBD` - Solomon Islands Dollar + + * `SOS` - Somali Shilling + + * `ZAR` - South African Rand + + * `ZAL` - South African Rand (financial) + + * `KRH` - South Korean Hwan (1953–1962) + + * `KRW` - South Korean Won + + * `KRO` - South Korean Won (1945–1953) + + * `SSP` - South Sudanese Pound + + * `SUR` - Soviet Rouble + + * `ESP` - Spanish Peseta + + * `ESA` - Spanish Peseta (A account) + + * `ESB` - Spanish Peseta (convertible account) + + * `XDR` - Special Drawing Rights + + * `LKR` - Sri Lankan Rupee + + * `SHP` - St. Helena Pound + + * `XSU` - Sucre + + * `SDD` - Sudanese Dinar (1992–2007) + + * `SDG` - Sudanese Pound + + * `SDP` - Sudanese Pound (1957–1998) + + * `SRD` - Surinamese Dollar + + * `SRG` - Surinamese Guilder + + * `SZL` - Swazi Lilangeni + + * `SEK` - Swedish Krona + + * `CHF` - Swiss Franc + + * `SYP` - Syrian Pound + + * `STN` - São Tomé & Príncipe Dobra + + * `STD` - São Tomé & Príncipe Dobra (1977–2017) + + * `TVD` - TVD + + * `TJR` - Tajikistani Ruble + + * `TJS` - Tajikistani Somoni + + * `TZS` - Tanzanian Shilling + + * `XTS` - Testing Currency Code + + * `THB` - Thai Baht + + * `XXX` - The codes assigned for transactions where no currency is + involved + + * `TPE` - Timorese Escudo + + * `TOP` - Tongan Paʻanga + + * `TTD` - Trinidad & Tobago Dollar + + * `TND` - Tunisian Dinar + + * `TRY` - Turkish Lira + + * `TRL` - Turkish Lira (1922–2005) + + * `TMT` - Turkmenistani Manat + + * `TMM` - Turkmenistani Manat (1993–2009) + + * `USD` - US Dollar + + * `USN` - US Dollar (Next day) + + * `USS` - US Dollar (Same day) + + * `UGX` - Ugandan Shilling + + * `UGS` - Ugandan Shilling (1966–1987) + + * `UAH` - Ukrainian Hryvnia + + * `UAK` - Ukrainian Karbovanets + + * `AED` - United Arab Emirates Dirham + + * `UYW` - Uruguayan Nominal Wage Index Unit + + * `UYU` - Uruguayan Peso + + * `UYP` - Uruguayan Peso (1975–1993) + + * `UYI` - Uruguayan Peso (Indexed Units) + + * `UZS` - Uzbekistani Som + + * `VUV` - Vanuatu Vatu + + * `VES` - Venezuelan Bolívar + + * `VEB` - Venezuelan Bolívar (1871–2008) + + * `VEF` - Venezuelan Bolívar (2008–2018) + + * `VND` - Vietnamese Dong + + * `VNN` - Vietnamese Dong (1978–1985) + + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) + company: + type: optional + docs: '`Company` object for the given `BalanceSheet` object.' + date: + type: optional + docs: >- + The balance sheet's date. The balance sheet data will reflect the + company's financial position this point in time. + net_assets: + type: optional + docs: The balance sheet's net assets. + assets: + type: optional> + access: read-only + liabilities: + type: optional> + access: read-only + equity: + type: optional> + access: read-only + remote_generated_at: + type: optional + docs: The time that balance sheet was generated by the accounting system. + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + BankFeedAccountCurrency: + discriminated: false + docs: >- + The currency code of the bank feed. + + + * `XUA` - ADB Unit of Account + + * `AFN` - Afghan Afghani + + * `AFA` - Afghan Afghani (1927–2002) + + * `ALL` - Albanian Lek + + * `ALK` - Albanian Lek (1946–1965) + + * `DZD` - Algerian Dinar + + * `ADP` - Andorran Peseta + + * `AOA` - Angolan Kwanza + + * `AOK` - Angolan Kwanza (1977–1991) + + * `AON` - Angolan New Kwanza (1990–2000) + + * `AOR` - Angolan Readjusted Kwanza (1995–1999) + + * `ARA` - Argentine Austral + + * `ARS` - Argentine Peso + + * `ARM` - Argentine Peso (1881–1970) + + * `ARP` - Argentine Peso (1983–1985) + + * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram @@ -5492,32 +5579,48 @@ types: source: openapi: openapi/openapi.yml inline: true - BalanceSheetCompany: + BankFeedAccountFeedStatus: discriminated: false - docs: '`Company` object for the given `BalanceSheet` object.' + docs: |- + The status of the bank feed. + + * `ACTIVE` - ACTIVE + * `INACTIVE` - INACTIVE union: - - type: string - validation: - format: uuid - - CompanyInfo + - FeedStatusEnum + - string source: openapi: openapi/openapi.yml inline: true - BalanceSheet: + BankFeedAccountAccountType: + discriminated: false + docs: |- + The type of the account. + + * `BANK` - BANK + * `CREDIT_CARD` - CREDIT_CARD + union: + - BankFeedAccountAccountTypeEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + BankFeedAccount: docs: >- - # The BalanceSheet Object + # The BankFeedAccount Object ### Description - The `BalanceSheet` object shows a company’s assets, liabilities, and - equity. Assets should be equal to liability and equity combined. This - shows the company’s financial health at a specific point in time. + The `BankFeedAccount` object represents a bank feed account, detailing + various attributes including account identifiers, names, currency, and + balance information. This object is central to managing and tracking bank + feed accounts within the system. ### Usage Example - Fetch from the `LIST BalanceSheets` endpoint and view a company's balance - sheets. + Fetch from the `GET BankFeedAccount` endpoint to view details of a bank + feed account. properties: id: type: optional @@ -5535,13 +5638,41 @@ types: type: optional docs: The datetime that this object was modified by Merge. access: read-only - name: + source_account_id: type: optional - docs: The balance sheet's name. + docs: >- + The unique identifier of the source account from our customer’s + platform. + validation: + maxLength: 1024 + target_account_id: + type: optional + docs: >- + The unique identifier of the target account from the third party + software. + validation: + maxLength: 1024 + source_account_name: + type: optional + docs: The name of the source account as stored in our customer’s platform. + validation: + maxLength: 1024 + source_account_number: + type: optional + docs: >- + The human-readable account number of the source account as stored in + our customer’s platform. + validation: + maxLength: 1024 + target_account_name: + type: optional + docs: The name of the target account from the third party software. + validation: + maxLength: 1024 currency: - type: optional + type: optional docs: >- - The balance sheet's currency. + The currency code of the bank feed. * `XUA` - ADB Unit of Account @@ -6156,29 +6287,26 @@ types: * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) - company: - type: optional - docs: '`Company` object for the given `BalanceSheet` object.' - date: + feed_status: + type: optional + docs: |- + The status of the bank feed. + + * `ACTIVE` - ACTIVE + * `INACTIVE` - INACTIVE + feed_start_date: type: optional - docs: >- - The balance sheet's date. The balance sheet data will reflect the - company's financial position this point in time. - net_assets: + docs: The start date of the bank feed’s transactions. + source_account_balance: type: optional - docs: The balance sheet's net assets. - assets: - type: optional> - access: read-only - liabilities: - type: optional> - access: read-only - equity: - type: optional> - access: read-only - remote_generated_at: - type: optional - docs: The time that balance sheet was generated by the accounting system. + docs: The current balance of funds in the source account. + account_type: + type: optional + docs: |- + The type of the account. + + * `BANK` - BANK + * `CREDIT_CARD` - CREDIT_CARD remote_was_deleted: type: optional docs: >- @@ -6187,16 +6315,22 @@ types: Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only field_mappings: type: optional> access: read-only - remote_data: - type: optional> - access: read-only + remote_data: optional>>> source: openapi: openapi/openapi.yml - BankFeedAccountCurrency: + BankFeedAccountAccountTypeEnum: + enum: + - BANK + - CREDIT_CARD + docs: |- + * `BANK` - BANK + * `CREDIT_CARD` - CREDIT_CARD + source: + openapi: openapi/openapi.yml + BankFeedAccountRequestCurrency: discriminated: false docs: >- The currency code of the bank feed. @@ -6630,6695 +6764,1162 @@ types: * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble - - * `RUR` - Russian Ruble (1991–1998) - - * `RWF` - Rwandan Franc - - * `SVC` - Salvadoran Colón - - * `WST` - Samoan Tala - - * `SAR` - Saudi Riyal - - * `RSD` - Serbian Dinar - - * `CSD` - Serbian Dinar (2002–2006) - - * `SCR` - Seychellois Rupee - - * `SLL` - Sierra Leonean Leone - - * `XAG` - Silver - - * `SGD` - Singapore Dollar - - * `SKK` - Slovak Koruna - - * `SIT` - Slovenian Tolar - - * `SBD` - Solomon Islands Dollar - - * `SOS` - Somali Shilling - - * `ZAR` - South African Rand - - * `ZAL` - South African Rand (financial) - - * `KRH` - South Korean Hwan (1953–1962) - - * `KRW` - South Korean Won - - * `KRO` - South Korean Won (1945–1953) - - * `SSP` - South Sudanese Pound - - * `SUR` - Soviet Rouble - - * `ESP` - Spanish Peseta - - * `ESA` - Spanish Peseta (A account) - - * `ESB` - Spanish Peseta (convertible account) - - * `XDR` - Special Drawing Rights - - * `LKR` - Sri Lankan Rupee - - * `SHP` - St. Helena Pound - - * `XSU` - Sucre - - * `SDD` - Sudanese Dinar (1992–2007) - - * `SDG` - Sudanese Pound - - * `SDP` - Sudanese Pound (1957–1998) - - * `SRD` - Surinamese Dollar - - * `SRG` - Surinamese Guilder - - * `SZL` - Swazi Lilangeni - - * `SEK` - Swedish Krona - - * `CHF` - Swiss Franc - - * `SYP` - Syrian Pound - - * `STN` - São Tomé & Príncipe Dobra - - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - - * `TVD` - TVD - - * `TJR` - Tajikistani Ruble - - * `TJS` - Tajikistani Somoni - - * `TZS` - Tanzanian Shilling - - * `XTS` - Testing Currency Code - - * `THB` - Thai Baht - - * `XXX` - The codes assigned for transactions where no currency is - involved - - * `TPE` - Timorese Escudo - - * `TOP` - Tongan Paʻanga - - * `TTD` - Trinidad & Tobago Dollar - - * `TND` - Tunisian Dinar - - * `TRY` - Turkish Lira - - * `TRL` - Turkish Lira (1922–2005) - - * `TMT` - Turkmenistani Manat - - * `TMM` - Turkmenistani Manat (1993–2009) - - * `USD` - US Dollar - - * `USN` - US Dollar (Next day) - - * `USS` - US Dollar (Same day) - - * `UGX` - Ugandan Shilling - - * `UGS` - Ugandan Shilling (1966–1987) - - * `UAH` - Ukrainian Hryvnia - - * `UAK` - Ukrainian Karbovanets - - * `AED` - United Arab Emirates Dirham - - * `UYW` - Uruguayan Nominal Wage Index Unit - - * `UYU` - Uruguayan Peso - - * `UYP` - Uruguayan Peso (1975–1993) - - * `UYI` - Uruguayan Peso (Indexed Units) - - * `UZS` - Uzbekistani Som - - * `VUV` - Vanuatu Vatu - - * `VES` - Venezuelan Bolívar - - * `VEB` - Venezuelan Bolívar (1871–2008) - - * `VEF` - Venezuelan Bolívar (2008–2018) - - * `VND` - Vietnamese Dong - - * `VNN` - Vietnamese Dong (1978–1985) - - * `CHE` - WIR Euro - - * `CHW` - WIR Franc - - * `XOF` - West African CFA Franc - - * `YDD` - Yemeni Dinar - - * `YER` - Yemeni Rial - - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - - * `YUM` - Yugoslavian New Dinar (1994–2002) - - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - - * `ZWN` - ZWN - - * `ZRN` - Zairean New Zaire (1993–1998) - - * `ZRZ` - Zairean Zaire (1971–1993) - - * `ZMW` - Zambian Kwacha - - * `ZMK` - Zambian Kwacha (1968–2012) - - * `ZWD` - Zimbabwean Dollar (1980–2008) - - * `ZWR` - Zimbabwean Dollar (2008) - - * `ZWL` - Zimbabwean Dollar (2009) - union: - - TransactionCurrencyEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - BankFeedAccountFeedStatus: - discriminated: false - docs: |- - The status of the bank feed. - - * `ACTIVE` - ACTIVE - * `INACTIVE` - INACTIVE - union: - - FeedStatusEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - BankFeedAccountAccountType: - discriminated: false - docs: |- - The type of the account. - - * `BANK` - BANK - * `CREDIT_CARD` - CREDIT_CARD - union: - - BankFeedAccountAccountTypeEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - BankFeedAccount: - docs: >- - # The BankFeedAccount Object - - ### Description - - The `BankFeedAccount` object represents a bank feed account, detailing - various attributes including account identifiers, names, currency, and - balance information. This object is central to managing and tracking bank - feed accounts within the system. - - - ### Usage Example - - Fetch from the `GET BankFeedAccount` endpoint to view details of a bank - feed account. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - source_account_id: - type: optional - docs: >- - The unique identifier of the source account from our customer’s - platform. - validation: - maxLength: 1024 - target_account_id: - type: optional - docs: >- - The unique identifier of the target account from the third party - software. - validation: - maxLength: 1024 - source_account_name: - type: optional - docs: The name of the source account as stored in our customer’s platform. - validation: - maxLength: 1024 - source_account_number: - type: optional - docs: >- - The human-readable account number of the source account as stored in - our customer’s platform. - validation: - maxLength: 1024 - target_account_name: - type: optional - docs: The name of the target account from the third party software. - validation: - maxLength: 1024 - currency: - type: optional - docs: >- - The currency code of the bank feed. - - - * `XUA` - ADB Unit of Account - - * `AFN` - Afghan Afghani - - * `AFA` - Afghan Afghani (1927–2002) - - * `ALL` - Albanian Lek - - * `ALK` - Albanian Lek (1946–1965) - - * `DZD` - Algerian Dinar - - * `ADP` - Andorran Peseta - - * `AOA` - Angolan Kwanza - - * `AOK` - Angolan Kwanza (1977–1991) - - * `AON` - Angolan New Kwanza (1990–2000) - - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - - * `ARA` - Argentine Austral - - * `ARS` - Argentine Peso - - * `ARM` - Argentine Peso (1881–1970) - - * `ARP` - Argentine Peso (1983–1985) - - * `ARL` - Argentine Peso Ley (1970–1983) - - * `AMD` - Armenian Dram - - * `AWG` - Aruban Florin - - * `AUD` - Australian Dollar - - * `ATS` - Austrian Schilling - - * `AZN` - Azerbaijani Manat - - * `AZM` - Azerbaijani Manat (1993–2006) - - * `BSD` - Bahamian Dollar - - * `BHD` - Bahraini Dinar - - * `BDT` - Bangladeshi Taka - - * `BBD` - Barbadian Dollar - - * `BYN` - Belarusian Ruble - - * `BYB` - Belarusian Ruble (1994–1999) - - * `BYR` - Belarusian Ruble (2000–2016) - - * `BEF` - Belgian Franc - - * `BEC` - Belgian Franc (convertible) - - * `BEL` - Belgian Franc (financial) - - * `BZD` - Belize Dollar - - * `BMD` - Bermudan Dollar - - * `BTN` - Bhutanese Ngultrum - - * `BOB` - Bolivian Boliviano - - * `BOL` - Bolivian Boliviano (1863–1963) - - * `BOV` - Bolivian Mvdol - - * `BOP` - Bolivian Peso - - * `BAM` - Bosnia-Herzegovina Convertible Mark - - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - - * `BWP` - Botswanan Pula - - * `BRC` - Brazilian Cruzado (1986–1989) - - * `BRZ` - Brazilian Cruzeiro (1942–1967) - - * `BRE` - Brazilian Cruzeiro (1990–1993) - - * `BRR` - Brazilian Cruzeiro (1993–1994) - - * `BRN` - Brazilian New Cruzado (1989–1990) - - * `BRB` - Brazilian New Cruzeiro (1967–1986) - - * `BRL` - Brazilian Real - - * `GBP` - British Pound - - * `BND` - Brunei Dollar - - * `BGL` - Bulgarian Hard Lev - - * `BGN` - Bulgarian Lev - - * `BGO` - Bulgarian Lev (1879–1952) - - * `BGM` - Bulgarian Socialist Lev - - * `BUK` - Burmese Kyat - - * `BIF` - Burundian Franc - - * `XPF` - CFP Franc - - * `KHR` - Cambodian Riel - - * `CAD` - Canadian Dollar - - * `CVE` - Cape Verdean Escudo - - * `KYD` - Cayman Islands Dollar - - * `XAF` - Central African CFA Franc - - * `CLE` - Chilean Escudo - - * `CLP` - Chilean Peso - - * `CLF` - Chilean Unit of Account (UF) - - * `CNX` - Chinese People’s Bank Dollar - - * `CNY` - Chinese Yuan - - * `CNH` - Chinese Yuan (offshore) - - * `COP` - Colombian Peso - - * `COU` - Colombian Real Value Unit - - * `KMF` - Comorian Franc - - * `CDF` - Congolese Franc - - * `CRC` - Costa Rican Colón - - * `HRD` - Croatian Dinar - - * `HRK` - Croatian Kuna - - * `CUC` - Cuban Convertible Peso - - * `CUP` - Cuban Peso - - * `CYP` - Cypriot Pound - - * `CZK` - Czech Koruna - - * `CSK` - Czechoslovak Hard Koruna - - * `DKK` - Danish Krone - - * `DJF` - Djiboutian Franc - - * `DOP` - Dominican Peso - - * `NLG` - Dutch Guilder - - * `XCD` - East Caribbean Dollar - - * `DDM` - East German Mark - - * `ECS` - Ecuadorian Sucre - - * `ECV` - Ecuadorian Unit of Constant Value - - * `EGP` - Egyptian Pound - - * `GQE` - Equatorial Guinean Ekwele - - * `ERN` - Eritrean Nakfa - - * `EEK` - Estonian Kroon - - * `ETB` - Ethiopian Birr - - * `EUR` - Euro - - * `XBA` - European Composite Unit - - * `XEU` - European Currency Unit - - * `XBB` - European Monetary Unit - - * `XBC` - European Unit of Account (XBC) - - * `XBD` - European Unit of Account (XBD) - - * `FKP` - Falkland Islands Pound - - * `FJD` - Fijian Dollar - - * `FIM` - Finnish Markka - - * `FRF` - French Franc - - * `XFO` - French Gold Franc - - * `XFU` - French UIC-Franc - - * `GMD` - Gambian Dalasi - - * `GEK` - Georgian Kupon Larit - - * `GEL` - Georgian Lari - - * `DEM` - German Mark - - * `GHS` - Ghanaian Cedi - - * `GHC` - Ghanaian Cedi (1979–2007) - - * `GIP` - Gibraltar Pound - - * `XAU` - Gold - - * `GRD` - Greek Drachma - - * `GTQ` - Guatemalan Quetzal - - * `GWP` - Guinea-Bissau Peso - - * `GNF` - Guinean Franc - - * `GNS` - Guinean Syli - - * `GYD` - Guyanaese Dollar - - * `HTG` - Haitian Gourde - - * `HNL` - Honduran Lempira - - * `HKD` - Hong Kong Dollar - - * `HUF` - Hungarian Forint - - * `IMP` - IMP - - * `ISK` - Icelandic Króna - - * `ISJ` - Icelandic Króna (1918–1981) - - * `INR` - Indian Rupee - - * `IDR` - Indonesian Rupiah - - * `IRR` - Iranian Rial - - * `IQD` - Iraqi Dinar - - * `IEP` - Irish Pound - - * `ILS` - Israeli New Shekel - - * `ILP` - Israeli Pound - - * `ILR` - Israeli Shekel (1980–1985) - - * `ITL` - Italian Lira - - * `JMD` - Jamaican Dollar - - * `JPY` - Japanese Yen - - * `JOD` - Jordanian Dinar - - * `KZT` - Kazakhstani Tenge - - * `KES` - Kenyan Shilling - - * `KWD` - Kuwaiti Dinar - - * `KGS` - Kyrgystani Som - - * `LAK` - Laotian Kip - - * `LVL` - Latvian Lats - - * `LVR` - Latvian Ruble - - * `LBP` - Lebanese Pound - - * `LSL` - Lesotho Loti - - * `LRD` - Liberian Dollar - - * `LYD` - Libyan Dinar - - * `LTL` - Lithuanian Litas - - * `LTT` - Lithuanian Talonas - - * `LUL` - Luxembourg Financial Franc - - * `LUC` - Luxembourgian Convertible Franc - - * `LUF` - Luxembourgian Franc - - * `MOP` - Macanese Pataca - - * `MKD` - Macedonian Denar - - * `MKN` - Macedonian Denar (1992–1993) - - * `MGA` - Malagasy Ariary - - * `MGF` - Malagasy Franc - - * `MWK` - Malawian Kwacha - - * `MYR` - Malaysian Ringgit - - * `MVR` - Maldivian Rufiyaa - - * `MVP` - Maldivian Rupee (1947–1981) - - * `MLF` - Malian Franc - - * `MTL` - Maltese Lira - - * `MTP` - Maltese Pound - - * `MRU` - Mauritanian Ouguiya - - * `MRO` - Mauritanian Ouguiya (1973–2017) - - * `MUR` - Mauritian Rupee - - * `MXV` - Mexican Investment Unit - - * `MXN` - Mexican Peso - - * `MXP` - Mexican Silver Peso (1861–1992) - - * `MDC` - Moldovan Cupon - - * `MDL` - Moldovan Leu - - * `MCF` - Monegasque Franc - - * `MNT` - Mongolian Tugrik - - * `MAD` - Moroccan Dirham - - * `MAF` - Moroccan Franc - - * `MZE` - Mozambican Escudo - - * `MZN` - Mozambican Metical - - * `MZM` - Mozambican Metical (1980–2006) - - * `MMK` - Myanmar Kyat - - * `NAD` - Namibian Dollar - - * `NPR` - Nepalese Rupee - - * `ANG` - Netherlands Antillean Guilder - - * `TWD` - New Taiwan Dollar - - * `NZD` - New Zealand Dollar - - * `NIO` - Nicaraguan Córdoba - - * `NIC` - Nicaraguan Córdoba (1988–1991) - - * `NGN` - Nigerian Naira - - * `KPW` - North Korean Won - - * `NOK` - Norwegian Krone - - * `OMR` - Omani Rial - - * `PKR` - Pakistani Rupee - - * `XPD` - Palladium - - * `PAB` - Panamanian Balboa - - * `PGK` - Papua New Guinean Kina - - * `PYG` - Paraguayan Guarani - - * `PEI` - Peruvian Inti - - * `PEN` - Peruvian Sol - - * `PES` - Peruvian Sol (1863–1965) - - * `PHP` - Philippine Peso - - * `XPT` - Platinum - - * `PLN` - Polish Zloty - - * `PLZ` - Polish Zloty (1950–1995) - - * `PTE` - Portuguese Escudo - - * `GWE` - Portuguese Guinea Escudo - - * `QAR` - Qatari Rial - - * `XRE` - RINET Funds - - * `RHD` - Rhodesian Dollar - - * `RON` - Romanian Leu - - * `ROL` - Romanian Leu (1952–2006) - - * `RUB` - Russian Ruble - - * `RUR` - Russian Ruble (1991–1998) - - * `RWF` - Rwandan Franc - - * `SVC` - Salvadoran Colón - - * `WST` - Samoan Tala - - * `SAR` - Saudi Riyal - - * `RSD` - Serbian Dinar - - * `CSD` - Serbian Dinar (2002–2006) - - * `SCR` - Seychellois Rupee - - * `SLL` - Sierra Leonean Leone - - * `XAG` - Silver - - * `SGD` - Singapore Dollar - - * `SKK` - Slovak Koruna - - * `SIT` - Slovenian Tolar - - * `SBD` - Solomon Islands Dollar - - * `SOS` - Somali Shilling - - * `ZAR` - South African Rand - - * `ZAL` - South African Rand (financial) - - * `KRH` - South Korean Hwan (1953–1962) - - * `KRW` - South Korean Won - - * `KRO` - South Korean Won (1945–1953) - - * `SSP` - South Sudanese Pound - - * `SUR` - Soviet Rouble - - * `ESP` - Spanish Peseta - - * `ESA` - Spanish Peseta (A account) - - * `ESB` - Spanish Peseta (convertible account) - - * `XDR` - Special Drawing Rights - - * `LKR` - Sri Lankan Rupee - - * `SHP` - St. Helena Pound - - * `XSU` - Sucre - - * `SDD` - Sudanese Dinar (1992–2007) - - * `SDG` - Sudanese Pound - - * `SDP` - Sudanese Pound (1957–1998) - - * `SRD` - Surinamese Dollar - - * `SRG` - Surinamese Guilder - - * `SZL` - Swazi Lilangeni - - * `SEK` - Swedish Krona - - * `CHF` - Swiss Franc - - * `SYP` - Syrian Pound - - * `STN` - São Tomé & Príncipe Dobra - - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - - * `TVD` - TVD - - * `TJR` - Tajikistani Ruble - - * `TJS` - Tajikistani Somoni - - * `TZS` - Tanzanian Shilling - - * `XTS` - Testing Currency Code - - * `THB` - Thai Baht - - * `XXX` - The codes assigned for transactions where no currency is - involved - - * `TPE` - Timorese Escudo - - * `TOP` - Tongan Paʻanga - - * `TTD` - Trinidad & Tobago Dollar - - * `TND` - Tunisian Dinar - - * `TRY` - Turkish Lira - - * `TRL` - Turkish Lira (1922–2005) - - * `TMT` - Turkmenistani Manat - - * `TMM` - Turkmenistani Manat (1993–2009) - - * `USD` - US Dollar - - * `USN` - US Dollar (Next day) - - * `USS` - US Dollar (Same day) - - * `UGX` - Ugandan Shilling - - * `UGS` - Ugandan Shilling (1966–1987) - - * `UAH` - Ukrainian Hryvnia - - * `UAK` - Ukrainian Karbovanets - - * `AED` - United Arab Emirates Dirham - - * `UYW` - Uruguayan Nominal Wage Index Unit - - * `UYU` - Uruguayan Peso - - * `UYP` - Uruguayan Peso (1975–1993) - - * `UYI` - Uruguayan Peso (Indexed Units) - - * `UZS` - Uzbekistani Som - - * `VUV` - Vanuatu Vatu - - * `VES` - Venezuelan Bolívar - - * `VEB` - Venezuelan Bolívar (1871–2008) - - * `VEF` - Venezuelan Bolívar (2008–2018) - - * `VND` - Vietnamese Dong - - * `VNN` - Vietnamese Dong (1978–1985) - - * `CHE` - WIR Euro - - * `CHW` - WIR Franc - - * `XOF` - West African CFA Franc - - * `YDD` - Yemeni Dinar - - * `YER` - Yemeni Rial - - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - - * `YUM` - Yugoslavian New Dinar (1994–2002) - - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - - * `ZWN` - ZWN - - * `ZRN` - Zairean New Zaire (1993–1998) - - * `ZRZ` - Zairean Zaire (1971–1993) - - * `ZMW` - Zambian Kwacha - - * `ZMK` - Zambian Kwacha (1968–2012) - - * `ZWD` - Zimbabwean Dollar (1980–2008) - - * `ZWR` - Zimbabwean Dollar (2008) - - * `ZWL` - Zimbabwean Dollar (2009) - feed_status: - type: optional - docs: |- - The status of the bank feed. - - * `ACTIVE` - ACTIVE - * `INACTIVE` - INACTIVE - feed_start_date: - type: optional - docs: The start date of the bank feed’s transactions. - source_account_balance: - type: optional - docs: The current balance of funds in the source account. - account_type: - type: optional - docs: |- - The type of the account. - - * `BANK` - BANK - * `CREDIT_CARD` - CREDIT_CARD - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - field_mappings: - type: optional> - access: read-only - remote_data: optional>>> - source: - openapi: openapi/openapi.yml - BankFeedAccountAccountTypeEnum: - enum: - - BANK - - CREDIT_CARD - docs: |- - * `BANK` - BANK - * `CREDIT_CARD` - CREDIT_CARD - source: - openapi: openapi/openapi.yml - BankFeedAccountRequestCurrency: - discriminated: false - docs: >- - The currency code of the bank feed. - - - * `XUA` - ADB Unit of Account - - * `AFN` - Afghan Afghani - - * `AFA` - Afghan Afghani (1927–2002) - - * `ALL` - Albanian Lek - - * `ALK` - Albanian Lek (1946–1965) - - * `DZD` - Algerian Dinar - - * `ADP` - Andorran Peseta - - * `AOA` - Angolan Kwanza - - * `AOK` - Angolan Kwanza (1977–1991) - - * `AON` - Angolan New Kwanza (1990–2000) - - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - - * `ARA` - Argentine Austral - - * `ARS` - Argentine Peso - - * `ARM` - Argentine Peso (1881–1970) - - * `ARP` - Argentine Peso (1983–1985) - - * `ARL` - Argentine Peso Ley (1970–1983) - - * `AMD` - Armenian Dram - - * `AWG` - Aruban Florin - - * `AUD` - Australian Dollar - - * `ATS` - Austrian Schilling - - * `AZN` - Azerbaijani Manat - - * `AZM` - Azerbaijani Manat (1993–2006) - - * `BSD` - Bahamian Dollar - - * `BHD` - Bahraini Dinar - - * `BDT` - Bangladeshi Taka - - * `BBD` - Barbadian Dollar - - * `BYN` - Belarusian Ruble - - * `BYB` - Belarusian Ruble (1994–1999) - - * `BYR` - Belarusian Ruble (2000–2016) - - * `BEF` - Belgian Franc - - * `BEC` - Belgian Franc (convertible) - - * `BEL` - Belgian Franc (financial) - - * `BZD` - Belize Dollar - - * `BMD` - Bermudan Dollar - - * `BTN` - Bhutanese Ngultrum - - * `BOB` - Bolivian Boliviano - - * `BOL` - Bolivian Boliviano (1863–1963) - - * `BOV` - Bolivian Mvdol - - * `BOP` - Bolivian Peso - - * `BAM` - Bosnia-Herzegovina Convertible Mark - - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - - * `BWP` - Botswanan Pula - - * `BRC` - Brazilian Cruzado (1986–1989) - - * `BRZ` - Brazilian Cruzeiro (1942–1967) - - * `BRE` - Brazilian Cruzeiro (1990–1993) - - * `BRR` - Brazilian Cruzeiro (1993–1994) - - * `BRN` - Brazilian New Cruzado (1989–1990) - - * `BRB` - Brazilian New Cruzeiro (1967–1986) - - * `BRL` - Brazilian Real - - * `GBP` - British Pound - - * `BND` - Brunei Dollar - - * `BGL` - Bulgarian Hard Lev - - * `BGN` - Bulgarian Lev - - * `BGO` - Bulgarian Lev (1879–1952) - - * `BGM` - Bulgarian Socialist Lev - - * `BUK` - Burmese Kyat - - * `BIF` - Burundian Franc - - * `XPF` - CFP Franc - - * `KHR` - Cambodian Riel - - * `CAD` - Canadian Dollar - - * `CVE` - Cape Verdean Escudo - - * `KYD` - Cayman Islands Dollar - - * `XAF` - Central African CFA Franc - - * `CLE` - Chilean Escudo - - * `CLP` - Chilean Peso - - * `CLF` - Chilean Unit of Account (UF) - - * `CNX` - Chinese People’s Bank Dollar - - * `CNY` - Chinese Yuan - - * `CNH` - Chinese Yuan (offshore) - - * `COP` - Colombian Peso - - * `COU` - Colombian Real Value Unit - - * `KMF` - Comorian Franc - - * `CDF` - Congolese Franc - - * `CRC` - Costa Rican Colón - - * `HRD` - Croatian Dinar - - * `HRK` - Croatian Kuna - - * `CUC` - Cuban Convertible Peso - - * `CUP` - Cuban Peso - - * `CYP` - Cypriot Pound - - * `CZK` - Czech Koruna - - * `CSK` - Czechoslovak Hard Koruna - - * `DKK` - Danish Krone - - * `DJF` - Djiboutian Franc - - * `DOP` - Dominican Peso - - * `NLG` - Dutch Guilder - - * `XCD` - East Caribbean Dollar - - * `DDM` - East German Mark - - * `ECS` - Ecuadorian Sucre - - * `ECV` - Ecuadorian Unit of Constant Value - - * `EGP` - Egyptian Pound - - * `GQE` - Equatorial Guinean Ekwele - - * `ERN` - Eritrean Nakfa - - * `EEK` - Estonian Kroon - - * `ETB` - Ethiopian Birr - - * `EUR` - Euro - - * `XBA` - European Composite Unit - - * `XEU` - European Currency Unit - - * `XBB` - European Monetary Unit - - * `XBC` - European Unit of Account (XBC) - - * `XBD` - European Unit of Account (XBD) - - * `FKP` - Falkland Islands Pound - - * `FJD` - Fijian Dollar - - * `FIM` - Finnish Markka - - * `FRF` - French Franc - - * `XFO` - French Gold Franc - - * `XFU` - French UIC-Franc - - * `GMD` - Gambian Dalasi - - * `GEK` - Georgian Kupon Larit - - * `GEL` - Georgian Lari - - * `DEM` - German Mark - - * `GHS` - Ghanaian Cedi - - * `GHC` - Ghanaian Cedi (1979–2007) - - * `GIP` - Gibraltar Pound - - * `XAU` - Gold - - * `GRD` - Greek Drachma - - * `GTQ` - Guatemalan Quetzal - - * `GWP` - Guinea-Bissau Peso - - * `GNF` - Guinean Franc - - * `GNS` - Guinean Syli - - * `GYD` - Guyanaese Dollar - - * `HTG` - Haitian Gourde - - * `HNL` - Honduran Lempira - - * `HKD` - Hong Kong Dollar - - * `HUF` - Hungarian Forint - - * `IMP` - IMP - - * `ISK` - Icelandic Króna - - * `ISJ` - Icelandic Króna (1918–1981) - - * `INR` - Indian Rupee - - * `IDR` - Indonesian Rupiah - - * `IRR` - Iranian Rial - - * `IQD` - Iraqi Dinar - - * `IEP` - Irish Pound - - * `ILS` - Israeli New Shekel - - * `ILP` - Israeli Pound - - * `ILR` - Israeli Shekel (1980–1985) - - * `ITL` - Italian Lira - - * `JMD` - Jamaican Dollar - - * `JPY` - Japanese Yen - - * `JOD` - Jordanian Dinar - - * `KZT` - Kazakhstani Tenge - - * `KES` - Kenyan Shilling - - * `KWD` - Kuwaiti Dinar - - * `KGS` - Kyrgystani Som - - * `LAK` - Laotian Kip - - * `LVL` - Latvian Lats - - * `LVR` - Latvian Ruble - - * `LBP` - Lebanese Pound - - * `LSL` - Lesotho Loti - - * `LRD` - Liberian Dollar - - * `LYD` - Libyan Dinar - - * `LTL` - Lithuanian Litas - - * `LTT` - Lithuanian Talonas - - * `LUL` - Luxembourg Financial Franc - - * `LUC` - Luxembourgian Convertible Franc - - * `LUF` - Luxembourgian Franc - - * `MOP` - Macanese Pataca - - * `MKD` - Macedonian Denar - - * `MKN` - Macedonian Denar (1992–1993) - - * `MGA` - Malagasy Ariary - - * `MGF` - Malagasy Franc - - * `MWK` - Malawian Kwacha - - * `MYR` - Malaysian Ringgit - - * `MVR` - Maldivian Rufiyaa - - * `MVP` - Maldivian Rupee (1947–1981) - - * `MLF` - Malian Franc - - * `MTL` - Maltese Lira - - * `MTP` - Maltese Pound - - * `MRU` - Mauritanian Ouguiya - - * `MRO` - Mauritanian Ouguiya (1973–2017) - - * `MUR` - Mauritian Rupee - - * `MXV` - Mexican Investment Unit - - * `MXN` - Mexican Peso - - * `MXP` - Mexican Silver Peso (1861–1992) - - * `MDC` - Moldovan Cupon - - * `MDL` - Moldovan Leu - - * `MCF` - Monegasque Franc - - * `MNT` - Mongolian Tugrik - - * `MAD` - Moroccan Dirham - - * `MAF` - Moroccan Franc - - * `MZE` - Mozambican Escudo - - * `MZN` - Mozambican Metical - - * `MZM` - Mozambican Metical (1980–2006) - - * `MMK` - Myanmar Kyat - - * `NAD` - Namibian Dollar - - * `NPR` - Nepalese Rupee - - * `ANG` - Netherlands Antillean Guilder - - * `TWD` - New Taiwan Dollar - - * `NZD` - New Zealand Dollar - - * `NIO` - Nicaraguan Córdoba - - * `NIC` - Nicaraguan Córdoba (1988–1991) - - * `NGN` - Nigerian Naira - - * `KPW` - North Korean Won - - * `NOK` - Norwegian Krone - - * `OMR` - Omani Rial - - * `PKR` - Pakistani Rupee - - * `XPD` - Palladium - - * `PAB` - Panamanian Balboa - - * `PGK` - Papua New Guinean Kina - - * `PYG` - Paraguayan Guarani - - * `PEI` - Peruvian Inti - - * `PEN` - Peruvian Sol - - * `PES` - Peruvian Sol (1863–1965) - - * `PHP` - Philippine Peso - - * `XPT` - Platinum - - * `PLN` - Polish Zloty - - * `PLZ` - Polish Zloty (1950–1995) - - * `PTE` - Portuguese Escudo - - * `GWE` - Portuguese Guinea Escudo - - * `QAR` - Qatari Rial - - * `XRE` - RINET Funds - - * `RHD` - Rhodesian Dollar - - * `RON` - Romanian Leu - - * `ROL` - Romanian Leu (1952–2006) - - * `RUB` - Russian Ruble - - * `RUR` - Russian Ruble (1991–1998) - - * `RWF` - Rwandan Franc - - * `SVC` - Salvadoran Colón - - * `WST` - Samoan Tala - - * `SAR` - Saudi Riyal - - * `RSD` - Serbian Dinar - - * `CSD` - Serbian Dinar (2002–2006) - - * `SCR` - Seychellois Rupee - - * `SLL` - Sierra Leonean Leone - - * `XAG` - Silver - - * `SGD` - Singapore Dollar - - * `SKK` - Slovak Koruna - - * `SIT` - Slovenian Tolar - - * `SBD` - Solomon Islands Dollar - - * `SOS` - Somali Shilling - - * `ZAR` - South African Rand - - * `ZAL` - South African Rand (financial) - - * `KRH` - South Korean Hwan (1953–1962) - - * `KRW` - South Korean Won - - * `KRO` - South Korean Won (1945–1953) - - * `SSP` - South Sudanese Pound - - * `SUR` - Soviet Rouble - - * `ESP` - Spanish Peseta - - * `ESA` - Spanish Peseta (A account) - - * `ESB` - Spanish Peseta (convertible account) - - * `XDR` - Special Drawing Rights - - * `LKR` - Sri Lankan Rupee - - * `SHP` - St. Helena Pound - - * `XSU` - Sucre - - * `SDD` - Sudanese Dinar (1992–2007) - - * `SDG` - Sudanese Pound - - * `SDP` - Sudanese Pound (1957–1998) - - * `SRD` - Surinamese Dollar - - * `SRG` - Surinamese Guilder - - * `SZL` - Swazi Lilangeni - - * `SEK` - Swedish Krona - - * `CHF` - Swiss Franc - - * `SYP` - Syrian Pound - - * `STN` - São Tomé & Príncipe Dobra - - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - - * `TVD` - TVD - - * `TJR` - Tajikistani Ruble - - * `TJS` - Tajikistani Somoni - - * `TZS` - Tanzanian Shilling - - * `XTS` - Testing Currency Code - - * `THB` - Thai Baht - - * `XXX` - The codes assigned for transactions where no currency is - involved - - * `TPE` - Timorese Escudo - - * `TOP` - Tongan Paʻanga - - * `TTD` - Trinidad & Tobago Dollar - - * `TND` - Tunisian Dinar - - * `TRY` - Turkish Lira - - * `TRL` - Turkish Lira (1922–2005) - - * `TMT` - Turkmenistani Manat - - * `TMM` - Turkmenistani Manat (1993–2009) - - * `USD` - US Dollar - - * `USN` - US Dollar (Next day) - - * `USS` - US Dollar (Same day) - - * `UGX` - Ugandan Shilling - - * `UGS` - Ugandan Shilling (1966–1987) - - * `UAH` - Ukrainian Hryvnia - - * `UAK` - Ukrainian Karbovanets - - * `AED` - United Arab Emirates Dirham - - * `UYW` - Uruguayan Nominal Wage Index Unit - - * `UYU` - Uruguayan Peso - - * `UYP` - Uruguayan Peso (1975–1993) - - * `UYI` - Uruguayan Peso (Indexed Units) - - * `UZS` - Uzbekistani Som - - * `VUV` - Vanuatu Vatu - - * `VES` - Venezuelan Bolívar - - * `VEB` - Venezuelan Bolívar (1871–2008) - - * `VEF` - Venezuelan Bolívar (2008–2018) - - * `VND` - Vietnamese Dong - - * `VNN` - Vietnamese Dong (1978–1985) - - * `CHE` - WIR Euro - - * `CHW` - WIR Franc - - * `XOF` - West African CFA Franc - - * `YDD` - Yemeni Dinar - - * `YER` - Yemeni Rial - - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - - * `YUM` - Yugoslavian New Dinar (1994–2002) - - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - - * `ZWN` - ZWN - - * `ZRN` - Zairean New Zaire (1993–1998) - - * `ZRZ` - Zairean Zaire (1971–1993) - - * `ZMW` - Zambian Kwacha - - * `ZMK` - Zambian Kwacha (1968–2012) - - * `ZWD` - Zimbabwean Dollar (1980–2008) - - * `ZWR` - Zimbabwean Dollar (2008) - - * `ZWL` - Zimbabwean Dollar (2009) - union: - - TransactionCurrencyEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - BankFeedAccountRequestFeedStatus: - discriminated: false - docs: |- - The status of the bank feed. - - * `ACTIVE` - ACTIVE - * `INACTIVE` - INACTIVE - union: - - FeedStatusEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - BankFeedAccountRequestAccountType: - discriminated: false - docs: |- - The type of the account. - - * `BANK` - BANK - * `CREDIT_CARD` - CREDIT_CARD - union: - - BankFeedAccountAccountTypeEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - BankFeedAccountRequest: - docs: >- - # The BankFeedAccount Object - - ### Description - - The `BankFeedAccount` object represents a bank feed account, detailing - various attributes including account identifiers, names, currency, and - balance information. This object is central to managing and tracking bank - feed accounts within the system. - - - ### Usage Example - - Fetch from the `GET BankFeedAccount` endpoint to view details of a bank - feed account. - properties: - source_account_id: - type: optional - docs: >- - The unique identifier of the source account from our customer’s - platform. - validation: - maxLength: 1024 - target_account_id: - type: optional - docs: >- - The unique identifier of the target account from the third party - software. - validation: - maxLength: 1024 - source_account_name: - type: optional - docs: The name of the source account as stored in our customer’s platform. - validation: - maxLength: 1024 - source_account_number: - type: optional - docs: >- - The human-readable account number of the source account as stored in - our customer’s platform. - validation: - maxLength: 1024 - target_account_name: - type: optional - docs: The name of the target account from the third party software. - validation: - maxLength: 1024 - currency: - type: optional - docs: >- - The currency code of the bank feed. - - - * `XUA` - ADB Unit of Account - - * `AFN` - Afghan Afghani - - * `AFA` - Afghan Afghani (1927–2002) - - * `ALL` - Albanian Lek - - * `ALK` - Albanian Lek (1946–1965) - - * `DZD` - Algerian Dinar - - * `ADP` - Andorran Peseta - - * `AOA` - Angolan Kwanza - - * `AOK` - Angolan Kwanza (1977–1991) - - * `AON` - Angolan New Kwanza (1990–2000) - - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - - * `ARA` - Argentine Austral - - * `ARS` - Argentine Peso - - * `ARM` - Argentine Peso (1881–1970) - - * `ARP` - Argentine Peso (1983–1985) - - * `ARL` - Argentine Peso Ley (1970–1983) - - * `AMD` - Armenian Dram - - * `AWG` - Aruban Florin - - * `AUD` - Australian Dollar - - * `ATS` - Austrian Schilling - - * `AZN` - Azerbaijani Manat - - * `AZM` - Azerbaijani Manat (1993–2006) - - * `BSD` - Bahamian Dollar - - * `BHD` - Bahraini Dinar - - * `BDT` - Bangladeshi Taka - - * `BBD` - Barbadian Dollar - - * `BYN` - Belarusian Ruble - - * `BYB` - Belarusian Ruble (1994–1999) - - * `BYR` - Belarusian Ruble (2000–2016) - - * `BEF` - Belgian Franc - - * `BEC` - Belgian Franc (convertible) - - * `BEL` - Belgian Franc (financial) - - * `BZD` - Belize Dollar - - * `BMD` - Bermudan Dollar - - * `BTN` - Bhutanese Ngultrum - - * `BOB` - Bolivian Boliviano - - * `BOL` - Bolivian Boliviano (1863–1963) - - * `BOV` - Bolivian Mvdol - - * `BOP` - Bolivian Peso - - * `BAM` - Bosnia-Herzegovina Convertible Mark - - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - - * `BWP` - Botswanan Pula - - * `BRC` - Brazilian Cruzado (1986–1989) - - * `BRZ` - Brazilian Cruzeiro (1942–1967) - - * `BRE` - Brazilian Cruzeiro (1990–1993) - - * `BRR` - Brazilian Cruzeiro (1993–1994) - - * `BRN` - Brazilian New Cruzado (1989–1990) - - * `BRB` - Brazilian New Cruzeiro (1967–1986) - - * `BRL` - Brazilian Real - - * `GBP` - British Pound - - * `BND` - Brunei Dollar - - * `BGL` - Bulgarian Hard Lev - - * `BGN` - Bulgarian Lev - - * `BGO` - Bulgarian Lev (1879–1952) - - * `BGM` - Bulgarian Socialist Lev - - * `BUK` - Burmese Kyat - - * `BIF` - Burundian Franc - - * `XPF` - CFP Franc - - * `KHR` - Cambodian Riel - - * `CAD` - Canadian Dollar - - * `CVE` - Cape Verdean Escudo - - * `KYD` - Cayman Islands Dollar - - * `XAF` - Central African CFA Franc - - * `CLE` - Chilean Escudo - - * `CLP` - Chilean Peso - - * `CLF` - Chilean Unit of Account (UF) - - * `CNX` - Chinese People’s Bank Dollar - - * `CNY` - Chinese Yuan - - * `CNH` - Chinese Yuan (offshore) - - * `COP` - Colombian Peso - - * `COU` - Colombian Real Value Unit - - * `KMF` - Comorian Franc - - * `CDF` - Congolese Franc - - * `CRC` - Costa Rican Colón - - * `HRD` - Croatian Dinar - - * `HRK` - Croatian Kuna - - * `CUC` - Cuban Convertible Peso - - * `CUP` - Cuban Peso - - * `CYP` - Cypriot Pound - - * `CZK` - Czech Koruna - - * `CSK` - Czechoslovak Hard Koruna - - * `DKK` - Danish Krone - - * `DJF` - Djiboutian Franc - - * `DOP` - Dominican Peso - - * `NLG` - Dutch Guilder - - * `XCD` - East Caribbean Dollar - - * `DDM` - East German Mark - - * `ECS` - Ecuadorian Sucre - - * `ECV` - Ecuadorian Unit of Constant Value - - * `EGP` - Egyptian Pound - - * `GQE` - Equatorial Guinean Ekwele - - * `ERN` - Eritrean Nakfa - - * `EEK` - Estonian Kroon - - * `ETB` - Ethiopian Birr - - * `EUR` - Euro - - * `XBA` - European Composite Unit - - * `XEU` - European Currency Unit - - * `XBB` - European Monetary Unit - - * `XBC` - European Unit of Account (XBC) - - * `XBD` - European Unit of Account (XBD) - - * `FKP` - Falkland Islands Pound - - * `FJD` - Fijian Dollar - - * `FIM` - Finnish Markka - - * `FRF` - French Franc - - * `XFO` - French Gold Franc - - * `XFU` - French UIC-Franc - - * `GMD` - Gambian Dalasi - - * `GEK` - Georgian Kupon Larit - - * `GEL` - Georgian Lari - - * `DEM` - German Mark - - * `GHS` - Ghanaian Cedi - - * `GHC` - Ghanaian Cedi (1979–2007) - - * `GIP` - Gibraltar Pound - - * `XAU` - Gold - - * `GRD` - Greek Drachma - - * `GTQ` - Guatemalan Quetzal - - * `GWP` - Guinea-Bissau Peso - - * `GNF` - Guinean Franc - - * `GNS` - Guinean Syli - - * `GYD` - Guyanaese Dollar - - * `HTG` - Haitian Gourde - - * `HNL` - Honduran Lempira - - * `HKD` - Hong Kong Dollar - - * `HUF` - Hungarian Forint - - * `IMP` - IMP - - * `ISK` - Icelandic Króna - - * `ISJ` - Icelandic Króna (1918–1981) - - * `INR` - Indian Rupee - - * `IDR` - Indonesian Rupiah - - * `IRR` - Iranian Rial - - * `IQD` - Iraqi Dinar - - * `IEP` - Irish Pound - - * `ILS` - Israeli New Shekel - - * `ILP` - Israeli Pound - - * `ILR` - Israeli Shekel (1980–1985) - - * `ITL` - Italian Lira - - * `JMD` - Jamaican Dollar - - * `JPY` - Japanese Yen - - * `JOD` - Jordanian Dinar - - * `KZT` - Kazakhstani Tenge - - * `KES` - Kenyan Shilling - - * `KWD` - Kuwaiti Dinar - - * `KGS` - Kyrgystani Som - - * `LAK` - Laotian Kip - - * `LVL` - Latvian Lats - - * `LVR` - Latvian Ruble - - * `LBP` - Lebanese Pound - - * `LSL` - Lesotho Loti - - * `LRD` - Liberian Dollar - - * `LYD` - Libyan Dinar - - * `LTL` - Lithuanian Litas - - * `LTT` - Lithuanian Talonas - - * `LUL` - Luxembourg Financial Franc - - * `LUC` - Luxembourgian Convertible Franc - - * `LUF` - Luxembourgian Franc - - * `MOP` - Macanese Pataca - - * `MKD` - Macedonian Denar - - * `MKN` - Macedonian Denar (1992–1993) - - * `MGA` - Malagasy Ariary - - * `MGF` - Malagasy Franc - - * `MWK` - Malawian Kwacha - - * `MYR` - Malaysian Ringgit - - * `MVR` - Maldivian Rufiyaa - - * `MVP` - Maldivian Rupee (1947–1981) - - * `MLF` - Malian Franc - - * `MTL` - Maltese Lira - - * `MTP` - Maltese Pound - - * `MRU` - Mauritanian Ouguiya - - * `MRO` - Mauritanian Ouguiya (1973–2017) - - * `MUR` - Mauritian Rupee - - * `MXV` - Mexican Investment Unit - - * `MXN` - Mexican Peso - - * `MXP` - Mexican Silver Peso (1861–1992) - - * `MDC` - Moldovan Cupon - - * `MDL` - Moldovan Leu - - * `MCF` - Monegasque Franc - - * `MNT` - Mongolian Tugrik - - * `MAD` - Moroccan Dirham - - * `MAF` - Moroccan Franc - - * `MZE` - Mozambican Escudo - - * `MZN` - Mozambican Metical - - * `MZM` - Mozambican Metical (1980–2006) - - * `MMK` - Myanmar Kyat - - * `NAD` - Namibian Dollar - - * `NPR` - Nepalese Rupee - - * `ANG` - Netherlands Antillean Guilder - - * `TWD` - New Taiwan Dollar - - * `NZD` - New Zealand Dollar - - * `NIO` - Nicaraguan Córdoba - - * `NIC` - Nicaraguan Córdoba (1988–1991) - - * `NGN` - Nigerian Naira - - * `KPW` - North Korean Won - - * `NOK` - Norwegian Krone - - * `OMR` - Omani Rial - - * `PKR` - Pakistani Rupee - - * `XPD` - Palladium - - * `PAB` - Panamanian Balboa - - * `PGK` - Papua New Guinean Kina - - * `PYG` - Paraguayan Guarani - - * `PEI` - Peruvian Inti - - * `PEN` - Peruvian Sol - - * `PES` - Peruvian Sol (1863–1965) - - * `PHP` - Philippine Peso - - * `XPT` - Platinum - - * `PLN` - Polish Zloty - - * `PLZ` - Polish Zloty (1950–1995) - - * `PTE` - Portuguese Escudo - - * `GWE` - Portuguese Guinea Escudo - - * `QAR` - Qatari Rial - - * `XRE` - RINET Funds - - * `RHD` - Rhodesian Dollar - - * `RON` - Romanian Leu - - * `ROL` - Romanian Leu (1952–2006) - - * `RUB` - Russian Ruble - - * `RUR` - Russian Ruble (1991–1998) - - * `RWF` - Rwandan Franc - - * `SVC` - Salvadoran Colón - - * `WST` - Samoan Tala - - * `SAR` - Saudi Riyal - - * `RSD` - Serbian Dinar - - * `CSD` - Serbian Dinar (2002–2006) - - * `SCR` - Seychellois Rupee - - * `SLL` - Sierra Leonean Leone - - * `XAG` - Silver - - * `SGD` - Singapore Dollar - - * `SKK` - Slovak Koruna - - * `SIT` - Slovenian Tolar - - * `SBD` - Solomon Islands Dollar - - * `SOS` - Somali Shilling - - * `ZAR` - South African Rand - - * `ZAL` - South African Rand (financial) - - * `KRH` - South Korean Hwan (1953–1962) - - * `KRW` - South Korean Won - - * `KRO` - South Korean Won (1945–1953) - - * `SSP` - South Sudanese Pound - - * `SUR` - Soviet Rouble - - * `ESP` - Spanish Peseta - - * `ESA` - Spanish Peseta (A account) - - * `ESB` - Spanish Peseta (convertible account) - - * `XDR` - Special Drawing Rights - - * `LKR` - Sri Lankan Rupee - - * `SHP` - St. Helena Pound - - * `XSU` - Sucre - - * `SDD` - Sudanese Dinar (1992–2007) - - * `SDG` - Sudanese Pound - - * `SDP` - Sudanese Pound (1957–1998) - - * `SRD` - Surinamese Dollar - - * `SRG` - Surinamese Guilder - - * `SZL` - Swazi Lilangeni - - * `SEK` - Swedish Krona - - * `CHF` - Swiss Franc - - * `SYP` - Syrian Pound - - * `STN` - São Tomé & Príncipe Dobra - - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - - * `TVD` - TVD - - * `TJR` - Tajikistani Ruble - - * `TJS` - Tajikistani Somoni - - * `TZS` - Tanzanian Shilling - - * `XTS` - Testing Currency Code - - * `THB` - Thai Baht - - * `XXX` - The codes assigned for transactions where no currency is - involved - - * `TPE` - Timorese Escudo - - * `TOP` - Tongan Paʻanga - - * `TTD` - Trinidad & Tobago Dollar - - * `TND` - Tunisian Dinar - - * `TRY` - Turkish Lira - - * `TRL` - Turkish Lira (1922–2005) - - * `TMT` - Turkmenistani Manat - - * `TMM` - Turkmenistani Manat (1993–2009) - - * `USD` - US Dollar - - * `USN` - US Dollar (Next day) - - * `USS` - US Dollar (Same day) - - * `UGX` - Ugandan Shilling - - * `UGS` - Ugandan Shilling (1966–1987) - - * `UAH` - Ukrainian Hryvnia - - * `UAK` - Ukrainian Karbovanets - - * `AED` - United Arab Emirates Dirham - - * `UYW` - Uruguayan Nominal Wage Index Unit - - * `UYU` - Uruguayan Peso - - * `UYP` - Uruguayan Peso (1975–1993) - - * `UYI` - Uruguayan Peso (Indexed Units) - - * `UZS` - Uzbekistani Som - - * `VUV` - Vanuatu Vatu - - * `VES` - Venezuelan Bolívar - - * `VEB` - Venezuelan Bolívar (1871–2008) - - * `VEF` - Venezuelan Bolívar (2008–2018) - - * `VND` - Vietnamese Dong - - * `VNN` - Vietnamese Dong (1978–1985) - - * `CHE` - WIR Euro - - * `CHW` - WIR Franc - - * `XOF` - West African CFA Franc - - * `YDD` - Yemeni Dinar - - * `YER` - Yemeni Rial - - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - - * `YUM` - Yugoslavian New Dinar (1994–2002) - - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - - * `ZWN` - ZWN - - * `ZRN` - Zairean New Zaire (1993–1998) - - * `ZRZ` - Zairean Zaire (1971–1993) - - * `ZMW` - Zambian Kwacha - - * `ZMK` - Zambian Kwacha (1968–2012) - - * `ZWD` - Zimbabwean Dollar (1980–2008) - - * `ZWR` - Zimbabwean Dollar (2008) - - * `ZWL` - Zimbabwean Dollar (2009) - feed_status: - type: optional - docs: |- - The status of the bank feed. - - * `ACTIVE` - ACTIVE - * `INACTIVE` - INACTIVE - feed_start_date: - type: optional - docs: The start date of the bank feed’s transactions. - source_account_balance: - type: optional - docs: The current balance of funds in the source account. - account_type: - type: optional - docs: |- - The type of the account. - - * `BANK` - BANK - * `CREDIT_CARD` - CREDIT_CARD - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - BankFeedAccountResponse: - properties: - model: BankFeedAccount - warnings: list - errors: list - logs: optional> - source: - openapi: openapi/openapi.yml - BankFeedTransactionBankFeedAccount: - discriminated: false - docs: The bank feed account associated with the transaction. - union: - - type: string - validation: - format: uuid - - BankFeedAccount - source: - openapi: openapi/openapi.yml - inline: true - BankFeedTransactionCreditOrDebit: - discriminated: false - docs: |- - If the transaction is of type debit or credit. - - * `CREDIT` - CREDIT - * `DEBIT` - DEBIT - union: - - CreditOrDebitEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - BankFeedTransaction: - docs: >- - # The BankFeedTransaction Object - - ### Description - - The `BankFeedTransaction` object is used to represent transactions linked - to a bank feed account. This includes details about the transaction such - as the date, amount, description, and type. - - - ### Usage Example - - Fetch from the `GET BankFeedTransaction` endpoint to view details of a - transaction associated with a bank feed account. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - bank_feed_account: - type: optional - docs: The bank feed account associated with the transaction. - transaction_date: - type: optional - docs: The date that the transaction occurred. - posted_date: - type: optional - docs: The date the transaction was posted to the bank account. - amount: - type: optional - docs: The amount of the transaction. - description: - type: optional - docs: The description of the transaction. - validation: - maxLength: 1024 - transaction_type: - type: optional - docs: The underlying type of the transaction. - validation: - maxLength: 1024 - payee: - type: optional - docs: >- - The person or merchant who initiated the transaction, or - alternatively, to whom the transaction was paid. - validation: - maxLength: 1024 - credit_or_debit: - type: optional - docs: |- - If the transaction is of type debit or credit. - - * `CREDIT` - CREDIT - * `DEBIT` - DEBIT - source_transaction_id: - type: optional - docs: The customer’s identifier for the transaction. - validation: - maxLength: 1024 - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - is_processed: - type: optional - docs: >- - Whether or not this transaction has been processed by the external - system. For example, NetSuite writes this field as True when the - SuiteApp has processed the transaction. - access: read-only - source: - openapi: openapi/openapi.yml - BankFeedTransactionRequestRequestBankFeedAccount: - discriminated: false - docs: The bank feed account associated with the transaction. - union: - - type: string - validation: - format: uuid - - BankFeedAccount - source: - openapi: openapi/openapi.yml - inline: true - BankFeedTransactionRequestRequestCreditOrDebit: - discriminated: false - docs: |- - If the transaction is of type debit or credit. - - * `CREDIT` - CREDIT - * `DEBIT` - DEBIT - union: - - CreditOrDebitEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - BankFeedTransactionRequestRequest: - docs: >- - # The BankFeedTransaction Object - - ### Description - - The `BankFeedTransaction` object is used to represent transactions linked - to a bank feed account. This includes details about the transaction such - as the date, amount, description, and type. - - - ### Usage Example - - Fetch from the `GET BankFeedTransaction` endpoint to view details of a - transaction associated with a bank feed account. - properties: - bank_feed_account: - type: optional - docs: The bank feed account associated with the transaction. - transaction_date: - type: optional - docs: The date that the transaction occurred. - posted_date: - type: optional - docs: The date the transaction was posted to the bank account. - amount: - type: optional - docs: The amount of the transaction. - description: - type: optional - docs: The description of the transaction. - validation: - maxLength: 1024 - transaction_type: - type: optional - docs: The underlying type of the transaction. - validation: - maxLength: 1024 - payee: - type: optional - docs: >- - The person or merchant who initiated the transaction, or - alternatively, to whom the transaction was paid. - validation: - maxLength: 1024 - credit_or_debit: - type: optional - docs: |- - If the transaction is of type debit or credit. - - * `CREDIT` - CREDIT - * `DEBIT` - DEBIT - source_transaction_id: - type: optional - docs: The customer’s identifier for the transaction. - validation: - maxLength: 1024 - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - BankFeedTransactionResponse: - properties: - model: BankFeedTransaction - warnings: list - errors: list - logs: optional> - source: - openapi: openapi/openapi.yml - CashFlowStatementCurrency: - discriminated: false - docs: >- - The cash flow statement's currency. - - - * `XUA` - ADB Unit of Account - - * `AFN` - Afghan Afghani - - * `AFA` - Afghan Afghani (1927–2002) - - * `ALL` - Albanian Lek - - * `ALK` - Albanian Lek (1946–1965) - - * `DZD` - Algerian Dinar - - * `ADP` - Andorran Peseta - - * `AOA` - Angolan Kwanza - - * `AOK` - Angolan Kwanza (1977–1991) - - * `AON` - Angolan New Kwanza (1990–2000) - - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - - * `ARA` - Argentine Austral - - * `ARS` - Argentine Peso - - * `ARM` - Argentine Peso (1881–1970) - - * `ARP` - Argentine Peso (1983–1985) - - * `ARL` - Argentine Peso Ley (1970–1983) - - * `AMD` - Armenian Dram - - * `AWG` - Aruban Florin - - * `AUD` - Australian Dollar - - * `ATS` - Austrian Schilling - - * `AZN` - Azerbaijani Manat - - * `AZM` - Azerbaijani Manat (1993–2006) - - * `BSD` - Bahamian Dollar - - * `BHD` - Bahraini Dinar - - * `BDT` - Bangladeshi Taka - - * `BBD` - Barbadian Dollar - - * `BYN` - Belarusian Ruble - - * `BYB` - Belarusian Ruble (1994–1999) - - * `BYR` - Belarusian Ruble (2000–2016) - - * `BEF` - Belgian Franc - - * `BEC` - Belgian Franc (convertible) - - * `BEL` - Belgian Franc (financial) - - * `BZD` - Belize Dollar - - * `BMD` - Bermudan Dollar - - * `BTN` - Bhutanese Ngultrum - - * `BOB` - Bolivian Boliviano - - * `BOL` - Bolivian Boliviano (1863–1963) - - * `BOV` - Bolivian Mvdol - - * `BOP` - Bolivian Peso - - * `BAM` - Bosnia-Herzegovina Convertible Mark - - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - - * `BWP` - Botswanan Pula - - * `BRC` - Brazilian Cruzado (1986–1989) - - * `BRZ` - Brazilian Cruzeiro (1942–1967) - - * `BRE` - Brazilian Cruzeiro (1990–1993) - - * `BRR` - Brazilian Cruzeiro (1993–1994) - - * `BRN` - Brazilian New Cruzado (1989–1990) - - * `BRB` - Brazilian New Cruzeiro (1967–1986) - - * `BRL` - Brazilian Real - - * `GBP` - British Pound - - * `BND` - Brunei Dollar - - * `BGL` - Bulgarian Hard Lev - - * `BGN` - Bulgarian Lev - - * `BGO` - Bulgarian Lev (1879–1952) - - * `BGM` - Bulgarian Socialist Lev - - * `BUK` - Burmese Kyat - - * `BIF` - Burundian Franc - - * `XPF` - CFP Franc - - * `KHR` - Cambodian Riel - - * `CAD` - Canadian Dollar - - * `CVE` - Cape Verdean Escudo - - * `KYD` - Cayman Islands Dollar - - * `XAF` - Central African CFA Franc - - * `CLE` - Chilean Escudo - - * `CLP` - Chilean Peso - - * `CLF` - Chilean Unit of Account (UF) - - * `CNX` - Chinese People’s Bank Dollar - - * `CNY` - Chinese Yuan - - * `CNH` - Chinese Yuan (offshore) - - * `COP` - Colombian Peso - - * `COU` - Colombian Real Value Unit - - * `KMF` - Comorian Franc - - * `CDF` - Congolese Franc - - * `CRC` - Costa Rican Colón - - * `HRD` - Croatian Dinar - - * `HRK` - Croatian Kuna - - * `CUC` - Cuban Convertible Peso - - * `CUP` - Cuban Peso - - * `CYP` - Cypriot Pound - - * `CZK` - Czech Koruna - - * `CSK` - Czechoslovak Hard Koruna - - * `DKK` - Danish Krone - - * `DJF` - Djiboutian Franc - - * `DOP` - Dominican Peso - - * `NLG` - Dutch Guilder - - * `XCD` - East Caribbean Dollar - - * `DDM` - East German Mark - - * `ECS` - Ecuadorian Sucre - - * `ECV` - Ecuadorian Unit of Constant Value - - * `EGP` - Egyptian Pound - - * `GQE` - Equatorial Guinean Ekwele - - * `ERN` - Eritrean Nakfa - - * `EEK` - Estonian Kroon - - * `ETB` - Ethiopian Birr - - * `EUR` - Euro - - * `XBA` - European Composite Unit - - * `XEU` - European Currency Unit - - * `XBB` - European Monetary Unit - - * `XBC` - European Unit of Account (XBC) - - * `XBD` - European Unit of Account (XBD) - - * `FKP` - Falkland Islands Pound - - * `FJD` - Fijian Dollar - - * `FIM` - Finnish Markka - - * `FRF` - French Franc - - * `XFO` - French Gold Franc - - * `XFU` - French UIC-Franc - - * `GMD` - Gambian Dalasi - - * `GEK` - Georgian Kupon Larit - - * `GEL` - Georgian Lari - - * `DEM` - German Mark - - * `GHS` - Ghanaian Cedi - - * `GHC` - Ghanaian Cedi (1979–2007) - - * `GIP` - Gibraltar Pound - - * `XAU` - Gold - - * `GRD` - Greek Drachma - - * `GTQ` - Guatemalan Quetzal - - * `GWP` - Guinea-Bissau Peso - - * `GNF` - Guinean Franc - - * `GNS` - Guinean Syli - - * `GYD` - Guyanaese Dollar - - * `HTG` - Haitian Gourde - - * `HNL` - Honduran Lempira - - * `HKD` - Hong Kong Dollar - - * `HUF` - Hungarian Forint - - * `IMP` - IMP - - * `ISK` - Icelandic Króna - - * `ISJ` - Icelandic Króna (1918–1981) - - * `INR` - Indian Rupee - - * `IDR` - Indonesian Rupiah - - * `IRR` - Iranian Rial - - * `IQD` - Iraqi Dinar - - * `IEP` - Irish Pound - - * `ILS` - Israeli New Shekel - - * `ILP` - Israeli Pound - - * `ILR` - Israeli Shekel (1980–1985) - - * `ITL` - Italian Lira - - * `JMD` - Jamaican Dollar - - * `JPY` - Japanese Yen - - * `JOD` - Jordanian Dinar - - * `KZT` - Kazakhstani Tenge - - * `KES` - Kenyan Shilling - - * `KWD` - Kuwaiti Dinar - - * `KGS` - Kyrgystani Som - - * `LAK` - Laotian Kip - - * `LVL` - Latvian Lats - - * `LVR` - Latvian Ruble - - * `LBP` - Lebanese Pound - - * `LSL` - Lesotho Loti - - * `LRD` - Liberian Dollar - - * `LYD` - Libyan Dinar - - * `LTL` - Lithuanian Litas - - * `LTT` - Lithuanian Talonas - - * `LUL` - Luxembourg Financial Franc - - * `LUC` - Luxembourgian Convertible Franc - - * `LUF` - Luxembourgian Franc - - * `MOP` - Macanese Pataca - - * `MKD` - Macedonian Denar - - * `MKN` - Macedonian Denar (1992–1993) - - * `MGA` - Malagasy Ariary - - * `MGF` - Malagasy Franc - - * `MWK` - Malawian Kwacha - - * `MYR` - Malaysian Ringgit - - * `MVR` - Maldivian Rufiyaa - - * `MVP` - Maldivian Rupee (1947–1981) - - * `MLF` - Malian Franc - - * `MTL` - Maltese Lira - - * `MTP` - Maltese Pound - - * `MRU` - Mauritanian Ouguiya - - * `MRO` - Mauritanian Ouguiya (1973–2017) - - * `MUR` - Mauritian Rupee - - * `MXV` - Mexican Investment Unit - - * `MXN` - Mexican Peso - - * `MXP` - Mexican Silver Peso (1861–1992) - - * `MDC` - Moldovan Cupon - - * `MDL` - Moldovan Leu - - * `MCF` - Monegasque Franc - - * `MNT` - Mongolian Tugrik - - * `MAD` - Moroccan Dirham - - * `MAF` - Moroccan Franc - - * `MZE` - Mozambican Escudo - - * `MZN` - Mozambican Metical - - * `MZM` - Mozambican Metical (1980–2006) - - * `MMK` - Myanmar Kyat - - * `NAD` - Namibian Dollar - - * `NPR` - Nepalese Rupee - - * `ANG` - Netherlands Antillean Guilder - - * `TWD` - New Taiwan Dollar - - * `NZD` - New Zealand Dollar - - * `NIO` - Nicaraguan Córdoba - - * `NIC` - Nicaraguan Córdoba (1988–1991) - - * `NGN` - Nigerian Naira - - * `KPW` - North Korean Won - - * `NOK` - Norwegian Krone - - * `OMR` - Omani Rial - - * `PKR` - Pakistani Rupee - - * `XPD` - Palladium - - * `PAB` - Panamanian Balboa - - * `PGK` - Papua New Guinean Kina - - * `PYG` - Paraguayan Guarani - - * `PEI` - Peruvian Inti - - * `PEN` - Peruvian Sol - - * `PES` - Peruvian Sol (1863–1965) - - * `PHP` - Philippine Peso - - * `XPT` - Platinum - - * `PLN` - Polish Zloty - - * `PLZ` - Polish Zloty (1950–1995) - - * `PTE` - Portuguese Escudo - - * `GWE` - Portuguese Guinea Escudo - - * `QAR` - Qatari Rial - - * `XRE` - RINET Funds - - * `RHD` - Rhodesian Dollar - - * `RON` - Romanian Leu - - * `ROL` - Romanian Leu (1952–2006) - - * `RUB` - Russian Ruble - - * `RUR` - Russian Ruble (1991–1998) - - * `RWF` - Rwandan Franc - - * `SVC` - Salvadoran Colón - - * `WST` - Samoan Tala - - * `SAR` - Saudi Riyal - - * `RSD` - Serbian Dinar - - * `CSD` - Serbian Dinar (2002–2006) - - * `SCR` - Seychellois Rupee - - * `SLL` - Sierra Leonean Leone - - * `XAG` - Silver - - * `SGD` - Singapore Dollar - - * `SKK` - Slovak Koruna - - * `SIT` - Slovenian Tolar - - * `SBD` - Solomon Islands Dollar - - * `SOS` - Somali Shilling - - * `ZAR` - South African Rand - - * `ZAL` - South African Rand (financial) - - * `KRH` - South Korean Hwan (1953–1962) - - * `KRW` - South Korean Won - - * `KRO` - South Korean Won (1945–1953) - - * `SSP` - South Sudanese Pound - - * `SUR` - Soviet Rouble - - * `ESP` - Spanish Peseta - - * `ESA` - Spanish Peseta (A account) - - * `ESB` - Spanish Peseta (convertible account) - - * `XDR` - Special Drawing Rights - - * `LKR` - Sri Lankan Rupee - - * `SHP` - St. Helena Pound - - * `XSU` - Sucre - - * `SDD` - Sudanese Dinar (1992–2007) - - * `SDG` - Sudanese Pound - - * `SDP` - Sudanese Pound (1957–1998) - - * `SRD` - Surinamese Dollar - - * `SRG` - Surinamese Guilder - - * `SZL` - Swazi Lilangeni - - * `SEK` - Swedish Krona - - * `CHF` - Swiss Franc - - * `SYP` - Syrian Pound - - * `STN` - São Tomé & Príncipe Dobra - - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - - * `TVD` - TVD - - * `TJR` - Tajikistani Ruble - - * `TJS` - Tajikistani Somoni - - * `TZS` - Tanzanian Shilling - - * `XTS` - Testing Currency Code - - * `THB` - Thai Baht - - * `XXX` - The codes assigned for transactions where no currency is - involved - - * `TPE` - Timorese Escudo - - * `TOP` - Tongan Paʻanga - - * `TTD` - Trinidad & Tobago Dollar - - * `TND` - Tunisian Dinar - - * `TRY` - Turkish Lira - - * `TRL` - Turkish Lira (1922–2005) - - * `TMT` - Turkmenistani Manat - - * `TMM` - Turkmenistani Manat (1993–2009) - - * `USD` - US Dollar - - * `USN` - US Dollar (Next day) - - * `USS` - US Dollar (Same day) - - * `UGX` - Ugandan Shilling - - * `UGS` - Ugandan Shilling (1966–1987) - - * `UAH` - Ukrainian Hryvnia - - * `UAK` - Ukrainian Karbovanets - - * `AED` - United Arab Emirates Dirham - - * `UYW` - Uruguayan Nominal Wage Index Unit - - * `UYU` - Uruguayan Peso - - * `UYP` - Uruguayan Peso (1975–1993) - - * `UYI` - Uruguayan Peso (Indexed Units) - - * `UZS` - Uzbekistani Som - - * `VUV` - Vanuatu Vatu - - * `VES` - Venezuelan Bolívar - - * `VEB` - Venezuelan Bolívar (1871–2008) - - * `VEF` - Venezuelan Bolívar (2008–2018) - - * `VND` - Vietnamese Dong - - * `VNN` - Vietnamese Dong (1978–1985) - - * `CHE` - WIR Euro - - * `CHW` - WIR Franc - - * `XOF` - West African CFA Franc - - * `YDD` - Yemeni Dinar - - * `YER` - Yemeni Rial - - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - - * `YUM` - Yugoslavian New Dinar (1994–2002) - - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - - * `ZWN` - ZWN - - * `ZRN` - Zairean New Zaire (1993–1998) - - * `ZRZ` - Zairean Zaire (1971–1993) - - * `ZMW` - Zambian Kwacha - - * `ZMK` - Zambian Kwacha (1968–2012) - - * `ZWD` - Zimbabwean Dollar (1980–2008) - - * `ZWR` - Zimbabwean Dollar (2008) - - * `ZWL` - Zimbabwean Dollar (2009) - union: - - TransactionCurrencyEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - CashFlowStatementCompany: - discriminated: false - docs: The company the cash flow statement belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true - CashFlowStatement: - docs: >- - # The CashFlowStatement Object - - ### Description - - The `CashFlowStatement` object shows operating activities, investing - activities, and financing activities over a period of time (month, - quarter, or year). - - - ### Usage Example - - Fetch from the `LIST CashFlowStatements` endpoint and view a company's - cash flow statements. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - name: - type: optional - docs: The cash flow statement's name. - currency: - type: optional - docs: >- - The cash flow statement's currency. - - - * `XUA` - ADB Unit of Account - - * `AFN` - Afghan Afghani - - * `AFA` - Afghan Afghani (1927–2002) - - * `ALL` - Albanian Lek - - * `ALK` - Albanian Lek (1946–1965) - - * `DZD` - Algerian Dinar - - * `ADP` - Andorran Peseta - - * `AOA` - Angolan Kwanza - - * `AOK` - Angolan Kwanza (1977–1991) - - * `AON` - Angolan New Kwanza (1990–2000) - - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - - * `ARA` - Argentine Austral - - * `ARS` - Argentine Peso - - * `ARM` - Argentine Peso (1881–1970) - - * `ARP` - Argentine Peso (1983–1985) - - * `ARL` - Argentine Peso Ley (1970–1983) - - * `AMD` - Armenian Dram - - * `AWG` - Aruban Florin - - * `AUD` - Australian Dollar - - * `ATS` - Austrian Schilling - - * `AZN` - Azerbaijani Manat - - * `AZM` - Azerbaijani Manat (1993–2006) - - * `BSD` - Bahamian Dollar - - * `BHD` - Bahraini Dinar - - * `BDT` - Bangladeshi Taka - - * `BBD` - Barbadian Dollar - - * `BYN` - Belarusian Ruble - - * `BYB` - Belarusian Ruble (1994–1999) - - * `BYR` - Belarusian Ruble (2000–2016) - - * `BEF` - Belgian Franc - - * `BEC` - Belgian Franc (convertible) - - * `BEL` - Belgian Franc (financial) - - * `BZD` - Belize Dollar - - * `BMD` - Bermudan Dollar - - * `BTN` - Bhutanese Ngultrum - - * `BOB` - Bolivian Boliviano - - * `BOL` - Bolivian Boliviano (1863–1963) - - * `BOV` - Bolivian Mvdol - - * `BOP` - Bolivian Peso - - * `BAM` - Bosnia-Herzegovina Convertible Mark - - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - - * `BWP` - Botswanan Pula - - * `BRC` - Brazilian Cruzado (1986–1989) - - * `BRZ` - Brazilian Cruzeiro (1942–1967) - - * `BRE` - Brazilian Cruzeiro (1990–1993) - - * `BRR` - Brazilian Cruzeiro (1993–1994) - - * `BRN` - Brazilian New Cruzado (1989–1990) - - * `BRB` - Brazilian New Cruzeiro (1967–1986) - - * `BRL` - Brazilian Real - - * `GBP` - British Pound - - * `BND` - Brunei Dollar - - * `BGL` - Bulgarian Hard Lev - - * `BGN` - Bulgarian Lev - - * `BGO` - Bulgarian Lev (1879–1952) - - * `BGM` - Bulgarian Socialist Lev - - * `BUK` - Burmese Kyat - - * `BIF` - Burundian Franc - - * `XPF` - CFP Franc - - * `KHR` - Cambodian Riel - - * `CAD` - Canadian Dollar - - * `CVE` - Cape Verdean Escudo - - * `KYD` - Cayman Islands Dollar - - * `XAF` - Central African CFA Franc - - * `CLE` - Chilean Escudo - - * `CLP` - Chilean Peso - - * `CLF` - Chilean Unit of Account (UF) - - * `CNX` - Chinese People’s Bank Dollar - - * `CNY` - Chinese Yuan - - * `CNH` - Chinese Yuan (offshore) - - * `COP` - Colombian Peso - - * `COU` - Colombian Real Value Unit - - * `KMF` - Comorian Franc - - * `CDF` - Congolese Franc - - * `CRC` - Costa Rican Colón - - * `HRD` - Croatian Dinar - - * `HRK` - Croatian Kuna - - * `CUC` - Cuban Convertible Peso - - * `CUP` - Cuban Peso - - * `CYP` - Cypriot Pound - - * `CZK` - Czech Koruna - - * `CSK` - Czechoslovak Hard Koruna - - * `DKK` - Danish Krone - - * `DJF` - Djiboutian Franc - - * `DOP` - Dominican Peso - - * `NLG` - Dutch Guilder - - * `XCD` - East Caribbean Dollar - - * `DDM` - East German Mark - - * `ECS` - Ecuadorian Sucre - - * `ECV` - Ecuadorian Unit of Constant Value - - * `EGP` - Egyptian Pound - - * `GQE` - Equatorial Guinean Ekwele - - * `ERN` - Eritrean Nakfa - - * `EEK` - Estonian Kroon - - * `ETB` - Ethiopian Birr - - * `EUR` - Euro - - * `XBA` - European Composite Unit - - * `XEU` - European Currency Unit - - * `XBB` - European Monetary Unit - - * `XBC` - European Unit of Account (XBC) - - * `XBD` - European Unit of Account (XBD) - - * `FKP` - Falkland Islands Pound - - * `FJD` - Fijian Dollar - - * `FIM` - Finnish Markka - - * `FRF` - French Franc - - * `XFO` - French Gold Franc - - * `XFU` - French UIC-Franc - - * `GMD` - Gambian Dalasi - - * `GEK` - Georgian Kupon Larit - - * `GEL` - Georgian Lari - - * `DEM` - German Mark - - * `GHS` - Ghanaian Cedi - - * `GHC` - Ghanaian Cedi (1979–2007) - - * `GIP` - Gibraltar Pound - - * `XAU` - Gold - - * `GRD` - Greek Drachma - - * `GTQ` - Guatemalan Quetzal - - * `GWP` - Guinea-Bissau Peso - - * `GNF` - Guinean Franc - - * `GNS` - Guinean Syli - - * `GYD` - Guyanaese Dollar - - * `HTG` - Haitian Gourde - - * `HNL` - Honduran Lempira - - * `HKD` - Hong Kong Dollar - - * `HUF` - Hungarian Forint - - * `IMP` - IMP - - * `ISK` - Icelandic Króna - - * `ISJ` - Icelandic Króna (1918–1981) - - * `INR` - Indian Rupee - - * `IDR` - Indonesian Rupiah - - * `IRR` - Iranian Rial - - * `IQD` - Iraqi Dinar - - * `IEP` - Irish Pound - - * `ILS` - Israeli New Shekel - - * `ILP` - Israeli Pound - - * `ILR` - Israeli Shekel (1980–1985) - - * `ITL` - Italian Lira - - * `JMD` - Jamaican Dollar - - * `JPY` - Japanese Yen - - * `JOD` - Jordanian Dinar - - * `KZT` - Kazakhstani Tenge - - * `KES` - Kenyan Shilling - - * `KWD` - Kuwaiti Dinar - - * `KGS` - Kyrgystani Som - - * `LAK` - Laotian Kip - - * `LVL` - Latvian Lats - - * `LVR` - Latvian Ruble - - * `LBP` - Lebanese Pound - - * `LSL` - Lesotho Loti - - * `LRD` - Liberian Dollar - - * `LYD` - Libyan Dinar - - * `LTL` - Lithuanian Litas - - * `LTT` - Lithuanian Talonas - - * `LUL` - Luxembourg Financial Franc - - * `LUC` - Luxembourgian Convertible Franc - - * `LUF` - Luxembourgian Franc - - * `MOP` - Macanese Pataca - - * `MKD` - Macedonian Denar - - * `MKN` - Macedonian Denar (1992–1993) - - * `MGA` - Malagasy Ariary - - * `MGF` - Malagasy Franc - - * `MWK` - Malawian Kwacha - - * `MYR` - Malaysian Ringgit - - * `MVR` - Maldivian Rufiyaa - - * `MVP` - Maldivian Rupee (1947–1981) - - * `MLF` - Malian Franc - - * `MTL` - Maltese Lira - - * `MTP` - Maltese Pound - - * `MRU` - Mauritanian Ouguiya - - * `MRO` - Mauritanian Ouguiya (1973–2017) - - * `MUR` - Mauritian Rupee - - * `MXV` - Mexican Investment Unit - - * `MXN` - Mexican Peso - - * `MXP` - Mexican Silver Peso (1861–1992) - - * `MDC` - Moldovan Cupon - - * `MDL` - Moldovan Leu - - * `MCF` - Monegasque Franc - - * `MNT` - Mongolian Tugrik - - * `MAD` - Moroccan Dirham - - * `MAF` - Moroccan Franc - - * `MZE` - Mozambican Escudo - - * `MZN` - Mozambican Metical - - * `MZM` - Mozambican Metical (1980–2006) - - * `MMK` - Myanmar Kyat - - * `NAD` - Namibian Dollar - - * `NPR` - Nepalese Rupee - - * `ANG` - Netherlands Antillean Guilder - - * `TWD` - New Taiwan Dollar - - * `NZD` - New Zealand Dollar - - * `NIO` - Nicaraguan Córdoba - - * `NIC` - Nicaraguan Córdoba (1988–1991) - - * `NGN` - Nigerian Naira - - * `KPW` - North Korean Won - - * `NOK` - Norwegian Krone - - * `OMR` - Omani Rial - - * `PKR` - Pakistani Rupee - - * `XPD` - Palladium - - * `PAB` - Panamanian Balboa - - * `PGK` - Papua New Guinean Kina - - * `PYG` - Paraguayan Guarani - - * `PEI` - Peruvian Inti - - * `PEN` - Peruvian Sol - - * `PES` - Peruvian Sol (1863–1965) - - * `PHP` - Philippine Peso - - * `XPT` - Platinum - - * `PLN` - Polish Zloty - - * `PLZ` - Polish Zloty (1950–1995) - - * `PTE` - Portuguese Escudo - - * `GWE` - Portuguese Guinea Escudo - - * `QAR` - Qatari Rial - - * `XRE` - RINET Funds - - * `RHD` - Rhodesian Dollar - - * `RON` - Romanian Leu - - * `ROL` - Romanian Leu (1952–2006) - - * `RUB` - Russian Ruble - - * `RUR` - Russian Ruble (1991–1998) - - * `RWF` - Rwandan Franc - - * `SVC` - Salvadoran Colón - - * `WST` - Samoan Tala - - * `SAR` - Saudi Riyal - - * `RSD` - Serbian Dinar - - * `CSD` - Serbian Dinar (2002–2006) - - * `SCR` - Seychellois Rupee - - * `SLL` - Sierra Leonean Leone - - * `XAG` - Silver - - * `SGD` - Singapore Dollar - - * `SKK` - Slovak Koruna - - * `SIT` - Slovenian Tolar - - * `SBD` - Solomon Islands Dollar - - * `SOS` - Somali Shilling - - * `ZAR` - South African Rand - - * `ZAL` - South African Rand (financial) - - * `KRH` - South Korean Hwan (1953–1962) - - * `KRW` - South Korean Won - - * `KRO` - South Korean Won (1945–1953) - - * `SSP` - South Sudanese Pound - - * `SUR` - Soviet Rouble - - * `ESP` - Spanish Peseta - - * `ESA` - Spanish Peseta (A account) - - * `ESB` - Spanish Peseta (convertible account) - - * `XDR` - Special Drawing Rights - - * `LKR` - Sri Lankan Rupee - - * `SHP` - St. Helena Pound - - * `XSU` - Sucre - - * `SDD` - Sudanese Dinar (1992–2007) - - * `SDG` - Sudanese Pound - - * `SDP` - Sudanese Pound (1957–1998) - - * `SRD` - Surinamese Dollar - - * `SRG` - Surinamese Guilder - - * `SZL` - Swazi Lilangeni - - * `SEK` - Swedish Krona - - * `CHF` - Swiss Franc - - * `SYP` - Syrian Pound - - * `STN` - São Tomé & Príncipe Dobra - - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - - * `TVD` - TVD - - * `TJR` - Tajikistani Ruble - - * `TJS` - Tajikistani Somoni - - * `TZS` - Tanzanian Shilling - - * `XTS` - Testing Currency Code - - * `THB` - Thai Baht - - * `XXX` - The codes assigned for transactions where no currency is - involved - - * `TPE` - Timorese Escudo - - * `TOP` - Tongan Paʻanga - - * `TTD` - Trinidad & Tobago Dollar - - * `TND` - Tunisian Dinar - - * `TRY` - Turkish Lira - - * `TRL` - Turkish Lira (1922–2005) - - * `TMT` - Turkmenistani Manat - - * `TMM` - Turkmenistani Manat (1993–2009) - - * `USD` - US Dollar - - * `USN` - US Dollar (Next day) - - * `USS` - US Dollar (Same day) - - * `UGX` - Ugandan Shilling - - * `UGS` - Ugandan Shilling (1966–1987) - - * `UAH` - Ukrainian Hryvnia - - * `UAK` - Ukrainian Karbovanets - - * `AED` - United Arab Emirates Dirham - - * `UYW` - Uruguayan Nominal Wage Index Unit - - * `UYU` - Uruguayan Peso - - * `UYP` - Uruguayan Peso (1975–1993) - - * `UYI` - Uruguayan Peso (Indexed Units) - - * `UZS` - Uzbekistani Som - - * `VUV` - Vanuatu Vatu - - * `VES` - Venezuelan Bolívar - - * `VEB` - Venezuelan Bolívar (1871–2008) - - * `VEF` - Venezuelan Bolívar (2008–2018) - - * `VND` - Vietnamese Dong - - * `VNN` - Vietnamese Dong (1978–1985) - - * `CHE` - WIR Euro - - * `CHW` - WIR Franc - - * `XOF` - West African CFA Franc - - * `YDD` - Yemeni Dinar - - * `YER` - Yemeni Rial - - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - - * `YUM` - Yugoslavian New Dinar (1994–2002) - - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - - * `ZWN` - ZWN - - * `ZRN` - Zairean New Zaire (1993–1998) - - * `ZRZ` - Zairean Zaire (1971–1993) - - * `ZMW` - Zambian Kwacha - - * `ZMK` - Zambian Kwacha (1968–2012) - - * `ZWD` - Zimbabwean Dollar (1980–2008) - - * `ZWR` - Zimbabwean Dollar (2008) - - * `ZWL` - Zimbabwean Dollar (2009) - company: - type: optional - docs: The company the cash flow statement belongs to. - start_period: - type: optional - docs: The cash flow statement's start period. - end_period: - type: optional - docs: The cash flow statement's end period. - cash_at_beginning_of_period: - type: optional - docs: >- - Cash and cash equivalents at the beginning of the cash flow - statement's period. - cash_at_end_of_period: - type: optional - docs: >- - Cash and cash equivalents at the beginning of the cash flow - statement's period. - operating_activities: - type: optional> - access: read-only - investing_activities: - type: optional> - access: read-only - financing_activities: - type: optional> - access: read-only - remote_generated_at: - type: optional - docs: >- - The time that cash flow statement was generated by the accounting - system. - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - CategoriesEnum: - enum: - - hris - - ats - - accounting - - ticketing - - crm - - mktg - - filestorage - docs: |- - * `hris` - hris - * `ats` - ats - * `accounting` - accounting - * `ticketing` - ticketing - * `crm` - crm - * `mktg` - mktg - * `filestorage` - filestorage - source: - openapi: openapi/openapi.yml - CategoryEnum: - enum: - - hris - - ats - - accounting - - ticketing - - crm - - mktg - - filestorage - docs: |- - * `hris` - hris - * `ats` - ats - * `accounting` - accounting - * `ticketing` - ticketing - * `crm` - crm - * `mktg` - mktg - * `filestorage` - filestorage - source: - openapi: openapi/openapi.yml - CategoryTypeEnum: - enum: - - CLASS - - DEPARTMENT - docs: |- - * `CLASS` - CLASS - * `DEPARTMENT` - DEPARTMENT - source: - openapi: openapi/openapi.yml - ClassificationEnum: - enum: - - ASSET - - EQUITY - - EXPENSE - - LIABILITY - - REVENUE - docs: |- - * `ASSET` - ASSET - * `EQUITY` - EQUITY - * `EXPENSE` - EXPENSE - * `LIABILITY` - LIABILITY - * `REVENUE` - REVENUE - source: - openapi: openapi/openapi.yml - CommonModelScopeApi: - properties: - common_models: - docs: The common models you want to update the scopes for - type: list - source: - openapi: openapi/openapi.yml - CommonModelScopesBodyRequest: - properties: - model_id: - type: string - validation: - minLength: 1 - enabled_actions: list - disabled_fields: list - source: - openapi: openapi/openapi.yml - CompanyInfoCurrency: - discriminated: false - docs: >- - The currency set in the company's accounting platform. - - - * `XUA` - ADB Unit of Account - - * `AFN` - Afghan Afghani - - * `AFA` - Afghan Afghani (1927–2002) - - * `ALL` - Albanian Lek - - * `ALK` - Albanian Lek (1946–1965) - - * `DZD` - Algerian Dinar - - * `ADP` - Andorran Peseta - - * `AOA` - Angolan Kwanza - - * `AOK` - Angolan Kwanza (1977–1991) - - * `AON` - Angolan New Kwanza (1990–2000) - - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - - * `ARA` - Argentine Austral - - * `ARS` - Argentine Peso - - * `ARM` - Argentine Peso (1881–1970) - - * `ARP` - Argentine Peso (1983–1985) - - * `ARL` - Argentine Peso Ley (1970–1983) - - * `AMD` - Armenian Dram - - * `AWG` - Aruban Florin - - * `AUD` - Australian Dollar - - * `ATS` - Austrian Schilling - - * `AZN` - Azerbaijani Manat - - * `AZM` - Azerbaijani Manat (1993–2006) - - * `BSD` - Bahamian Dollar - - * `BHD` - Bahraini Dinar - - * `BDT` - Bangladeshi Taka - - * `BBD` - Barbadian Dollar - - * `BYN` - Belarusian Ruble - - * `BYB` - Belarusian Ruble (1994–1999) - - * `BYR` - Belarusian Ruble (2000–2016) - - * `BEF` - Belgian Franc - - * `BEC` - Belgian Franc (convertible) - - * `BEL` - Belgian Franc (financial) - - * `BZD` - Belize Dollar - - * `BMD` - Bermudan Dollar - - * `BTN` - Bhutanese Ngultrum - - * `BOB` - Bolivian Boliviano - - * `BOL` - Bolivian Boliviano (1863–1963) - - * `BOV` - Bolivian Mvdol - - * `BOP` - Bolivian Peso - - * `BAM` - Bosnia-Herzegovina Convertible Mark - - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - - * `BWP` - Botswanan Pula - - * `BRC` - Brazilian Cruzado (1986–1989) - - * `BRZ` - Brazilian Cruzeiro (1942–1967) - - * `BRE` - Brazilian Cruzeiro (1990–1993) - - * `BRR` - Brazilian Cruzeiro (1993–1994) - - * `BRN` - Brazilian New Cruzado (1989–1990) - - * `BRB` - Brazilian New Cruzeiro (1967–1986) - - * `BRL` - Brazilian Real - - * `GBP` - British Pound - - * `BND` - Brunei Dollar - - * `BGL` - Bulgarian Hard Lev - - * `BGN` - Bulgarian Lev - - * `BGO` - Bulgarian Lev (1879–1952) - - * `BGM` - Bulgarian Socialist Lev - - * `BUK` - Burmese Kyat - - * `BIF` - Burundian Franc - - * `XPF` - CFP Franc - - * `KHR` - Cambodian Riel - - * `CAD` - Canadian Dollar - - * `CVE` - Cape Verdean Escudo - - * `KYD` - Cayman Islands Dollar - - * `XAF` - Central African CFA Franc - - * `CLE` - Chilean Escudo - - * `CLP` - Chilean Peso - - * `CLF` - Chilean Unit of Account (UF) - - * `CNX` - Chinese People’s Bank Dollar - - * `CNY` - Chinese Yuan - - * `CNH` - Chinese Yuan (offshore) - - * `COP` - Colombian Peso - - * `COU` - Colombian Real Value Unit - - * `KMF` - Comorian Franc - - * `CDF` - Congolese Franc - - * `CRC` - Costa Rican Colón - - * `HRD` - Croatian Dinar - - * `HRK` - Croatian Kuna - - * `CUC` - Cuban Convertible Peso - - * `CUP` - Cuban Peso - - * `CYP` - Cypriot Pound - - * `CZK` - Czech Koruna - - * `CSK` - Czechoslovak Hard Koruna - - * `DKK` - Danish Krone - - * `DJF` - Djiboutian Franc - - * `DOP` - Dominican Peso - - * `NLG` - Dutch Guilder - - * `XCD` - East Caribbean Dollar - - * `DDM` - East German Mark - - * `ECS` - Ecuadorian Sucre - - * `ECV` - Ecuadorian Unit of Constant Value - - * `EGP` - Egyptian Pound - - * `GQE` - Equatorial Guinean Ekwele - - * `ERN` - Eritrean Nakfa - - * `EEK` - Estonian Kroon - - * `ETB` - Ethiopian Birr - - * `EUR` - Euro - - * `XBA` - European Composite Unit - - * `XEU` - European Currency Unit - - * `XBB` - European Monetary Unit - - * `XBC` - European Unit of Account (XBC) - - * `XBD` - European Unit of Account (XBD) - - * `FKP` - Falkland Islands Pound - - * `FJD` - Fijian Dollar - - * `FIM` - Finnish Markka - - * `FRF` - French Franc - - * `XFO` - French Gold Franc - - * `XFU` - French UIC-Franc - - * `GMD` - Gambian Dalasi - - * `GEK` - Georgian Kupon Larit - - * `GEL` - Georgian Lari - - * `DEM` - German Mark - - * `GHS` - Ghanaian Cedi - - * `GHC` - Ghanaian Cedi (1979–2007) - - * `GIP` - Gibraltar Pound - - * `XAU` - Gold - - * `GRD` - Greek Drachma - - * `GTQ` - Guatemalan Quetzal - - * `GWP` - Guinea-Bissau Peso - - * `GNF` - Guinean Franc - - * `GNS` - Guinean Syli - - * `GYD` - Guyanaese Dollar - - * `HTG` - Haitian Gourde - - * `HNL` - Honduran Lempira - - * `HKD` - Hong Kong Dollar - - * `HUF` - Hungarian Forint - - * `IMP` - IMP - - * `ISK` - Icelandic Króna - - * `ISJ` - Icelandic Króna (1918–1981) - - * `INR` - Indian Rupee - - * `IDR` - Indonesian Rupiah - - * `IRR` - Iranian Rial - - * `IQD` - Iraqi Dinar - - * `IEP` - Irish Pound - - * `ILS` - Israeli New Shekel - - * `ILP` - Israeli Pound - - * `ILR` - Israeli Shekel (1980–1985) - - * `ITL` - Italian Lira - - * `JMD` - Jamaican Dollar - - * `JPY` - Japanese Yen - - * `JOD` - Jordanian Dinar - - * `KZT` - Kazakhstani Tenge - - * `KES` - Kenyan Shilling - - * `KWD` - Kuwaiti Dinar - - * `KGS` - Kyrgystani Som - - * `LAK` - Laotian Kip - - * `LVL` - Latvian Lats - - * `LVR` - Latvian Ruble - - * `LBP` - Lebanese Pound - - * `LSL` - Lesotho Loti - - * `LRD` - Liberian Dollar - - * `LYD` - Libyan Dinar - - * `LTL` - Lithuanian Litas - - * `LTT` - Lithuanian Talonas - - * `LUL` - Luxembourg Financial Franc - - * `LUC` - Luxembourgian Convertible Franc - - * `LUF` - Luxembourgian Franc - - * `MOP` - Macanese Pataca - - * `MKD` - Macedonian Denar - - * `MKN` - Macedonian Denar (1992–1993) - - * `MGA` - Malagasy Ariary - - * `MGF` - Malagasy Franc - - * `MWK` - Malawian Kwacha - - * `MYR` - Malaysian Ringgit - - * `MVR` - Maldivian Rufiyaa - - * `MVP` - Maldivian Rupee (1947–1981) - - * `MLF` - Malian Franc - - * `MTL` - Maltese Lira - - * `MTP` - Maltese Pound - - * `MRU` - Mauritanian Ouguiya - - * `MRO` - Mauritanian Ouguiya (1973–2017) - - * `MUR` - Mauritian Rupee - - * `MXV` - Mexican Investment Unit - - * `MXN` - Mexican Peso - - * `MXP` - Mexican Silver Peso (1861–1992) - - * `MDC` - Moldovan Cupon - - * `MDL` - Moldovan Leu - - * `MCF` - Monegasque Franc - - * `MNT` - Mongolian Tugrik - - * `MAD` - Moroccan Dirham - - * `MAF` - Moroccan Franc - - * `MZE` - Mozambican Escudo - - * `MZN` - Mozambican Metical - - * `MZM` - Mozambican Metical (1980–2006) - - * `MMK` - Myanmar Kyat - - * `NAD` - Namibian Dollar - - * `NPR` - Nepalese Rupee - - * `ANG` - Netherlands Antillean Guilder - - * `TWD` - New Taiwan Dollar - - * `NZD` - New Zealand Dollar - - * `NIO` - Nicaraguan Córdoba - - * `NIC` - Nicaraguan Córdoba (1988–1991) - - * `NGN` - Nigerian Naira - - * `KPW` - North Korean Won - - * `NOK` - Norwegian Krone - - * `OMR` - Omani Rial - - * `PKR` - Pakistani Rupee - - * `XPD` - Palladium - - * `PAB` - Panamanian Balboa - - * `PGK` - Papua New Guinean Kina - - * `PYG` - Paraguayan Guarani - - * `PEI` - Peruvian Inti - - * `PEN` - Peruvian Sol - - * `PES` - Peruvian Sol (1863–1965) - - * `PHP` - Philippine Peso - - * `XPT` - Platinum - - * `PLN` - Polish Zloty - - * `PLZ` - Polish Zloty (1950–1995) - - * `PTE` - Portuguese Escudo - - * `GWE` - Portuguese Guinea Escudo - - * `QAR` - Qatari Rial - - * `XRE` - RINET Funds - - * `RHD` - Rhodesian Dollar - - * `RON` - Romanian Leu - - * `ROL` - Romanian Leu (1952–2006) - - * `RUB` - Russian Ruble - - * `RUR` - Russian Ruble (1991–1998) - - * `RWF` - Rwandan Franc - - * `SVC` - Salvadoran Colón - - * `WST` - Samoan Tala - - * `SAR` - Saudi Riyal - - * `RSD` - Serbian Dinar - - * `CSD` - Serbian Dinar (2002–2006) - - * `SCR` - Seychellois Rupee - - * `SLL` - Sierra Leonean Leone - - * `XAG` - Silver - - * `SGD` - Singapore Dollar - - * `SKK` - Slovak Koruna - - * `SIT` - Slovenian Tolar - - * `SBD` - Solomon Islands Dollar - - * `SOS` - Somali Shilling - - * `ZAR` - South African Rand - - * `ZAL` - South African Rand (financial) - - * `KRH` - South Korean Hwan (1953–1962) - - * `KRW` - South Korean Won - - * `KRO` - South Korean Won (1945–1953) - - * `SSP` - South Sudanese Pound - - * `SUR` - Soviet Rouble - - * `ESP` - Spanish Peseta - - * `ESA` - Spanish Peseta (A account) - - * `ESB` - Spanish Peseta (convertible account) - - * `XDR` - Special Drawing Rights - - * `LKR` - Sri Lankan Rupee - - * `SHP` - St. Helena Pound - - * `XSU` - Sucre - - * `SDD` - Sudanese Dinar (1992–2007) - - * `SDG` - Sudanese Pound - - * `SDP` - Sudanese Pound (1957–1998) - - * `SRD` - Surinamese Dollar - - * `SRG` - Surinamese Guilder - - * `SZL` - Swazi Lilangeni - - * `SEK` - Swedish Krona - - * `CHF` - Swiss Franc - - * `SYP` - Syrian Pound - - * `STN` - São Tomé & Príncipe Dobra - - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - - * `TVD` - TVD - - * `TJR` - Tajikistani Ruble - - * `TJS` - Tajikistani Somoni - - * `TZS` - Tanzanian Shilling - - * `XTS` - Testing Currency Code - - * `THB` - Thai Baht - - * `XXX` - The codes assigned for transactions where no currency is - involved - - * `TPE` - Timorese Escudo - - * `TOP` - Tongan Paʻanga - - * `TTD` - Trinidad & Tobago Dollar - - * `TND` - Tunisian Dinar - - * `TRY` - Turkish Lira - - * `TRL` - Turkish Lira (1922–2005) - - * `TMT` - Turkmenistani Manat - - * `TMM` - Turkmenistani Manat (1993–2009) - - * `USD` - US Dollar - - * `USN` - US Dollar (Next day) - - * `USS` - US Dollar (Same day) - - * `UGX` - Ugandan Shilling - - * `UGS` - Ugandan Shilling (1966–1987) - - * `UAH` - Ukrainian Hryvnia - - * `UAK` - Ukrainian Karbovanets - - * `AED` - United Arab Emirates Dirham - - * `UYW` - Uruguayan Nominal Wage Index Unit - - * `UYU` - Uruguayan Peso - - * `UYP` - Uruguayan Peso (1975–1993) - - * `UYI` - Uruguayan Peso (Indexed Units) - - * `UZS` - Uzbekistani Som - - * `VUV` - Vanuatu Vatu - - * `VES` - Venezuelan Bolívar - - * `VEB` - Venezuelan Bolívar (1871–2008) - - * `VEF` - Venezuelan Bolívar (2008–2018) - - * `VND` - Vietnamese Dong - - * `VNN` - Vietnamese Dong (1978–1985) - - * `CHE` - WIR Euro - - * `CHW` - WIR Franc - - * `XOF` - West African CFA Franc - - * `YDD` - Yemeni Dinar - - * `YER` - Yemeni Rial - - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - - * `YUM` - Yugoslavian New Dinar (1994–2002) - - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - - * `ZWN` - ZWN - - * `ZRN` - Zairean New Zaire (1993–1998) - - * `ZRZ` - Zairean Zaire (1971–1993) - - * `ZMW` - Zambian Kwacha - - * `ZMK` - Zambian Kwacha (1968–2012) - - * `ZWD` - Zimbabwean Dollar (1980–2008) - - * `ZWR` - Zimbabwean Dollar (2008) - - * `ZWL` - Zimbabwean Dollar (2009) - union: - - TransactionCurrencyEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - CompanyInfo: - docs: >- - # The CompanyInfo Object - - ### Description - - The `CompanyInfo` object contains information about the company of the - linked account. If the company has multiple entities (also known as - subsidiaries), each entity may show up as a single `CompanyInfo` record. - - - ### Usage Example - - Fetch from the `GET CompanyInfo` endpoint and view a company's - information. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - name: - type: optional - docs: The company's name. - legal_name: - type: optional - docs: The company's legal name. - tax_number: - type: optional - docs: The company's tax number. - fiscal_year_end_month: - type: optional - docs: The company's fiscal year end month. - validation: - min: 1 - max: 12 - fiscal_year_end_day: - type: optional - docs: The company's fiscal year end day. - validation: - min: 1 - max: 31 - currency: - type: optional - docs: >- - The currency set in the company's accounting platform. - - - * `XUA` - ADB Unit of Account - - * `AFN` - Afghan Afghani - - * `AFA` - Afghan Afghani (1927–2002) - - * `ALL` - Albanian Lek - - * `ALK` - Albanian Lek (1946–1965) - - * `DZD` - Algerian Dinar - - * `ADP` - Andorran Peseta - - * `AOA` - Angolan Kwanza - - * `AOK` - Angolan Kwanza (1977–1991) - - * `AON` - Angolan New Kwanza (1990–2000) - - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - - * `ARA` - Argentine Austral - - * `ARS` - Argentine Peso - - * `ARM` - Argentine Peso (1881–1970) - - * `ARP` - Argentine Peso (1983–1985) - - * `ARL` - Argentine Peso Ley (1970–1983) - - * `AMD` - Armenian Dram - - * `AWG` - Aruban Florin - - * `AUD` - Australian Dollar - - * `ATS` - Austrian Schilling - - * `AZN` - Azerbaijani Manat - - * `AZM` - Azerbaijani Manat (1993–2006) - - * `BSD` - Bahamian Dollar - - * `BHD` - Bahraini Dinar - - * `BDT` - Bangladeshi Taka - - * `BBD` - Barbadian Dollar - - * `BYN` - Belarusian Ruble - - * `BYB` - Belarusian Ruble (1994–1999) - - * `BYR` - Belarusian Ruble (2000–2016) - - * `BEF` - Belgian Franc - - * `BEC` - Belgian Franc (convertible) - - * `BEL` - Belgian Franc (financial) - - * `BZD` - Belize Dollar - - * `BMD` - Bermudan Dollar - - * `BTN` - Bhutanese Ngultrum - - * `BOB` - Bolivian Boliviano - - * `BOL` - Bolivian Boliviano (1863–1963) - - * `BOV` - Bolivian Mvdol - - * `BOP` - Bolivian Peso - - * `BAM` - Bosnia-Herzegovina Convertible Mark - - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - - * `BWP` - Botswanan Pula - - * `BRC` - Brazilian Cruzado (1986–1989) - - * `BRZ` - Brazilian Cruzeiro (1942–1967) - - * `BRE` - Brazilian Cruzeiro (1990–1993) - - * `BRR` - Brazilian Cruzeiro (1993–1994) - - * `BRN` - Brazilian New Cruzado (1989–1990) - - * `BRB` - Brazilian New Cruzeiro (1967–1986) - - * `BRL` - Brazilian Real - - * `GBP` - British Pound - - * `BND` - Brunei Dollar - - * `BGL` - Bulgarian Hard Lev - - * `BGN` - Bulgarian Lev - - * `BGO` - Bulgarian Lev (1879–1952) - - * `BGM` - Bulgarian Socialist Lev - - * `BUK` - Burmese Kyat - - * `BIF` - Burundian Franc - - * `XPF` - CFP Franc - - * `KHR` - Cambodian Riel - - * `CAD` - Canadian Dollar - - * `CVE` - Cape Verdean Escudo - - * `KYD` - Cayman Islands Dollar - - * `XAF` - Central African CFA Franc - - * `CLE` - Chilean Escudo - - * `CLP` - Chilean Peso - - * `CLF` - Chilean Unit of Account (UF) - - * `CNX` - Chinese People’s Bank Dollar - - * `CNY` - Chinese Yuan - - * `CNH` - Chinese Yuan (offshore) - - * `COP` - Colombian Peso - - * `COU` - Colombian Real Value Unit - - * `KMF` - Comorian Franc - - * `CDF` - Congolese Franc - - * `CRC` - Costa Rican Colón - - * `HRD` - Croatian Dinar - - * `HRK` - Croatian Kuna - - * `CUC` - Cuban Convertible Peso - - * `CUP` - Cuban Peso - - * `CYP` - Cypriot Pound - - * `CZK` - Czech Koruna - - * `CSK` - Czechoslovak Hard Koruna - - * `DKK` - Danish Krone - - * `DJF` - Djiboutian Franc - - * `DOP` - Dominican Peso - - * `NLG` - Dutch Guilder - - * `XCD` - East Caribbean Dollar - - * `DDM` - East German Mark - - * `ECS` - Ecuadorian Sucre - - * `ECV` - Ecuadorian Unit of Constant Value - - * `EGP` - Egyptian Pound - - * `GQE` - Equatorial Guinean Ekwele - - * `ERN` - Eritrean Nakfa - - * `EEK` - Estonian Kroon - - * `ETB` - Ethiopian Birr - - * `EUR` - Euro - - * `XBA` - European Composite Unit - - * `XEU` - European Currency Unit - - * `XBB` - European Monetary Unit - - * `XBC` - European Unit of Account (XBC) - - * `XBD` - European Unit of Account (XBD) - - * `FKP` - Falkland Islands Pound - - * `FJD` - Fijian Dollar - - * `FIM` - Finnish Markka - - * `FRF` - French Franc - - * `XFO` - French Gold Franc - - * `XFU` - French UIC-Franc - - * `GMD` - Gambian Dalasi - - * `GEK` - Georgian Kupon Larit - - * `GEL` - Georgian Lari - - * `DEM` - German Mark - - * `GHS` - Ghanaian Cedi - - * `GHC` - Ghanaian Cedi (1979–2007) - - * `GIP` - Gibraltar Pound - - * `XAU` - Gold - - * `GRD` - Greek Drachma - - * `GTQ` - Guatemalan Quetzal - - * `GWP` - Guinea-Bissau Peso - - * `GNF` - Guinean Franc - - * `GNS` - Guinean Syli - - * `GYD` - Guyanaese Dollar - - * `HTG` - Haitian Gourde - - * `HNL` - Honduran Lempira - - * `HKD` - Hong Kong Dollar - - * `HUF` - Hungarian Forint - - * `IMP` - IMP - - * `ISK` - Icelandic Króna - - * `ISJ` - Icelandic Króna (1918–1981) - - * `INR` - Indian Rupee - - * `IDR` - Indonesian Rupiah - - * `IRR` - Iranian Rial - - * `IQD` - Iraqi Dinar - - * `IEP` - Irish Pound - - * `ILS` - Israeli New Shekel - - * `ILP` - Israeli Pound - - * `ILR` - Israeli Shekel (1980–1985) - - * `ITL` - Italian Lira - - * `JMD` - Jamaican Dollar - - * `JPY` - Japanese Yen - - * `JOD` - Jordanian Dinar - - * `KZT` - Kazakhstani Tenge - - * `KES` - Kenyan Shilling - - * `KWD` - Kuwaiti Dinar - - * `KGS` - Kyrgystani Som - - * `LAK` - Laotian Kip - - * `LVL` - Latvian Lats - - * `LVR` - Latvian Ruble - - * `LBP` - Lebanese Pound - - * `LSL` - Lesotho Loti - - * `LRD` - Liberian Dollar - - * `LYD` - Libyan Dinar - - * `LTL` - Lithuanian Litas - - * `LTT` - Lithuanian Talonas - - * `LUL` - Luxembourg Financial Franc - - * `LUC` - Luxembourgian Convertible Franc - - * `LUF` - Luxembourgian Franc - - * `MOP` - Macanese Pataca - - * `MKD` - Macedonian Denar - - * `MKN` - Macedonian Denar (1992–1993) - - * `MGA` - Malagasy Ariary - - * `MGF` - Malagasy Franc - - * `MWK` - Malawian Kwacha - - * `MYR` - Malaysian Ringgit - - * `MVR` - Maldivian Rufiyaa - - * `MVP` - Maldivian Rupee (1947–1981) - - * `MLF` - Malian Franc - - * `MTL` - Maltese Lira - - * `MTP` - Maltese Pound - - * `MRU` - Mauritanian Ouguiya - - * `MRO` - Mauritanian Ouguiya (1973–2017) - - * `MUR` - Mauritian Rupee - - * `MXV` - Mexican Investment Unit - - * `MXN` - Mexican Peso - - * `MXP` - Mexican Silver Peso (1861–1992) - - * `MDC` - Moldovan Cupon - - * `MDL` - Moldovan Leu - - * `MCF` - Monegasque Franc - - * `MNT` - Mongolian Tugrik - - * `MAD` - Moroccan Dirham - - * `MAF` - Moroccan Franc - - * `MZE` - Mozambican Escudo - - * `MZN` - Mozambican Metical - - * `MZM` - Mozambican Metical (1980–2006) - - * `MMK` - Myanmar Kyat - - * `NAD` - Namibian Dollar - - * `NPR` - Nepalese Rupee - - * `ANG` - Netherlands Antillean Guilder - - * `TWD` - New Taiwan Dollar - - * `NZD` - New Zealand Dollar - - * `NIO` - Nicaraguan Córdoba - - * `NIC` - Nicaraguan Córdoba (1988–1991) - - * `NGN` - Nigerian Naira - - * `KPW` - North Korean Won - - * `NOK` - Norwegian Krone - - * `OMR` - Omani Rial - - * `PKR` - Pakistani Rupee - - * `XPD` - Palladium - - * `PAB` - Panamanian Balboa - - * `PGK` - Papua New Guinean Kina - - * `PYG` - Paraguayan Guarani - - * `PEI` - Peruvian Inti - - * `PEN` - Peruvian Sol - - * `PES` - Peruvian Sol (1863–1965) - - * `PHP` - Philippine Peso - - * `XPT` - Platinum - - * `PLN` - Polish Zloty - - * `PLZ` - Polish Zloty (1950–1995) - - * `PTE` - Portuguese Escudo - - * `GWE` - Portuguese Guinea Escudo - - * `QAR` - Qatari Rial - - * `XRE` - RINET Funds - - * `RHD` - Rhodesian Dollar - - * `RON` - Romanian Leu - - * `ROL` - Romanian Leu (1952–2006) - - * `RUB` - Russian Ruble - - * `RUR` - Russian Ruble (1991–1998) - - * `RWF` - Rwandan Franc - - * `SVC` - Salvadoran Colón - - * `WST` - Samoan Tala - - * `SAR` - Saudi Riyal - - * `RSD` - Serbian Dinar - - * `CSD` - Serbian Dinar (2002–2006) - - * `SCR` - Seychellois Rupee - - * `SLL` - Sierra Leonean Leone - - * `XAG` - Silver - - * `SGD` - Singapore Dollar - - * `SKK` - Slovak Koruna - - * `SIT` - Slovenian Tolar - - * `SBD` - Solomon Islands Dollar - - * `SOS` - Somali Shilling - - * `ZAR` - South African Rand - - * `ZAL` - South African Rand (financial) - - * `KRH` - South Korean Hwan (1953–1962) - - * `KRW` - South Korean Won - - * `KRO` - South Korean Won (1945–1953) - - * `SSP` - South Sudanese Pound - - * `SUR` - Soviet Rouble - - * `ESP` - Spanish Peseta - - * `ESA` - Spanish Peseta (A account) - - * `ESB` - Spanish Peseta (convertible account) - - * `XDR` - Special Drawing Rights - - * `LKR` - Sri Lankan Rupee - - * `SHP` - St. Helena Pound - - * `XSU` - Sucre - - * `SDD` - Sudanese Dinar (1992–2007) - - * `SDG` - Sudanese Pound - - * `SDP` - Sudanese Pound (1957–1998) - - * `SRD` - Surinamese Dollar - - * `SRG` - Surinamese Guilder - - * `SZL` - Swazi Lilangeni - - * `SEK` - Swedish Krona - - * `CHF` - Swiss Franc - - * `SYP` - Syrian Pound - - * `STN` - São Tomé & Príncipe Dobra - - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - - * `TVD` - TVD - - * `TJR` - Tajikistani Ruble - - * `TJS` - Tajikistani Somoni - - * `TZS` - Tanzanian Shilling - - * `XTS` - Testing Currency Code - - * `THB` - Thai Baht - - * `XXX` - The codes assigned for transactions where no currency is - involved - - * `TPE` - Timorese Escudo - - * `TOP` - Tongan Paʻanga - - * `TTD` - Trinidad & Tobago Dollar - - * `TND` - Tunisian Dinar - - * `TRY` - Turkish Lira - - * `TRL` - Turkish Lira (1922–2005) - - * `TMT` - Turkmenistani Manat - - * `TMM` - Turkmenistani Manat (1993–2009) - - * `USD` - US Dollar - - * `USN` - US Dollar (Next day) - - * `USS` - US Dollar (Same day) - - * `UGX` - Ugandan Shilling - - * `UGS` - Ugandan Shilling (1966–1987) - - * `UAH` - Ukrainian Hryvnia - - * `UAK` - Ukrainian Karbovanets - - * `AED` - United Arab Emirates Dirham - - * `UYW` - Uruguayan Nominal Wage Index Unit - - * `UYU` - Uruguayan Peso - - * `UYP` - Uruguayan Peso (1975–1993) - - * `UYI` - Uruguayan Peso (Indexed Units) - - * `UZS` - Uzbekistani Som - - * `VUV` - Vanuatu Vatu - - * `VES` - Venezuelan Bolívar - - * `VEB` - Venezuelan Bolívar (1871–2008) - - * `VEF` - Venezuelan Bolívar (2008–2018) - - * `VND` - Vietnamese Dong - - * `VNN` - Vietnamese Dong (1978–1985) - - * `CHE` - WIR Euro - - * `CHW` - WIR Franc - - * `XOF` - West African CFA Franc - - * `YDD` - Yemeni Dinar - - * `YER` - Yemeni Rial - - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - - * `YUM` - Yugoslavian New Dinar (1994–2002) - - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - - * `ZWN` - ZWN - - * `ZRN` - Zairean New Zaire (1993–1998) - - * `ZRZ` - Zairean Zaire (1971–1993) - - * `ZMW` - Zambian Kwacha - - * `ZMK` - Zambian Kwacha (1968–2012) - - * `ZWD` - Zimbabwean Dollar (1980–2008) - - * `ZWR` - Zimbabwean Dollar (2008) - - * `ZWL` - Zimbabwean Dollar (2009) - remote_created_at: - type: optional - docs: When the third party's company was created. - urls: - type: optional>> - docs: The company's urls. - addresses: optional> - phone_numbers: optional> - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - ComponentTypeEnum: - enum: - - SALES - - PURCHASE - docs: |- - * `SALES` - SALES - * `PURCHASE` - PURCHASE - source: - openapi: openapi/openapi.yml - ContactStatus: - discriminated: false - docs: |- - The contact's status - - * `ACTIVE` - ACTIVE - * `ARCHIVED` - ARCHIVED - union: - - Status7D1Enum - - string - source: - openapi: openapi/openapi.yml - inline: true - ContactAddressesItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - Address - source: - openapi: openapi/openapi.yml - inline: true - Contact: - docs: >- - # The Contact Object - - ### Description - - A `Contact` is an individual or business entity to which products and - services are sold to or purchased from. The `Contact` model contains both - Customers, in which products and services are sold to, and Vendors (or - Suppliers), in which products and services are purchased from. - - * A `Contact` is a Vendor/Supplier if the `is_supplier` property is true. - - * A `Contact` is a customer if the `is_customer` property is true. - - - ### Usage Example - - Fetch from the `LIST Contacts` endpoint and view a company's contacts. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - name: - type: optional - docs: The contact's name. - is_supplier: - type: optional - docs: Whether the contact is a supplier. - is_customer: - type: optional - docs: Whether the contact is a customer. - email_address: - type: optional - docs: The contact's email address. - tax_number: - type: optional - docs: The contact's tax number. - status: - type: optional - docs: |- - The contact's status - - * `ACTIVE` - ACTIVE - * `ARCHIVED` - ARCHIVED - currency: - type: optional - docs: The currency the contact's transactions are in. - remote_updated_at: - type: optional - docs: When the third party's contact was updated. - company: - type: optional - docs: The company the contact belongs to. - validation: - format: uuid - addresses: - type: optional>> - docs: '`Address` object IDs for the given `Contacts` object.' - phone_numbers: - type: optional> - docs: '`AccountingPhoneNumber` object for the given `Contacts` object.' - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - remote_fields: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - ContactRequestStatus: - discriminated: false - docs: |- - The contact's status - - * `ACTIVE` - ACTIVE - * `ARCHIVED` - ARCHIVED - union: - - Status7D1Enum - - string - source: - openapi: openapi/openapi.yml - inline: true - ContactRequestAddressesItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - Address - source: - openapi: openapi/openapi.yml - inline: true - ContactRequest: - docs: >- - # The Contact Object - - ### Description - - A `Contact` is an individual or business entity to which products and - services are sold to or purchased from. The `Contact` model contains both - Customers, in which products and services are sold to, and Vendors (or - Suppliers), in which products and services are purchased from. - - * A `Contact` is a Vendor/Supplier if the `is_supplier` property is true. - - * A `Contact` is a customer if the `is_customer` property is true. - - - ### Usage Example - - Fetch from the `LIST Contacts` endpoint and view a company's contacts. - properties: - name: - type: optional - docs: The contact's name. - is_supplier: - type: optional - docs: Whether the contact is a supplier. - is_customer: - type: optional - docs: Whether the contact is a customer. - email_address: - type: optional - docs: The contact's email address. - tax_number: - type: optional - docs: The contact's tax number. - status: - type: optional - docs: |- - The contact's status - - * `ACTIVE` - ACTIVE - * `ARCHIVED` - ARCHIVED - currency: - type: optional - docs: The currency the contact's transactions are in. - company: - type: optional - docs: The company the contact belongs to. - validation: - format: uuid - addresses: - type: optional>> - docs: '`Address` object IDs for the given `Contacts` object.' - phone_numbers: - type: optional> - docs: '`AccountingPhoneNumber` object for the given `Contacts` object.' - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - remote_fields: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - ContactResponse: - properties: - model: Contact - warnings: list - errors: list - logs: optional> - source: - openapi: openapi/openapi.yml - CountryEnum: - enum: - - 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 - - DE - - 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 - - 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 - - KP - - MK - - MP - - 'NO' - - 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 - - KR - - SS - - ES - - LK - - SD - - SR - - SJ - - SE - - CH - - SY - - TW - - TJ - - TZ - - TH - - TL - - TG - - TK - - TO - - TT - - TN - - TR - - TM - - TC - - TV - - UG - - UA - - AE - - GB - - UM - - US - - UY - - UZ - - VU - - VE - - VN - - VG - - VI - - WF - - EH - - YE - - ZM - - ZW - docs: |- - * `AF` - Afghanistan - * `AX` - Åland Islands - * `AL` - Albania - * `DZ` - Algeria - * `AS` - American Samoa - * `AD` - Andorra - * `AO` - Angola - * `AI` - Anguilla - * `AQ` - Antarctica - * `AG` - Antigua and Barbuda - * `AR` - Argentina - * `AM` - Armenia - * `AW` - Aruba - * `AU` - Australia - * `AT` - Austria - * `AZ` - Azerbaijan - * `BS` - Bahamas - * `BH` - Bahrain - * `BD` - Bangladesh - * `BB` - Barbados - * `BY` - Belarus - * `BE` - Belgium - * `BZ` - Belize - * `BJ` - Benin - * `BM` - Bermuda - * `BT` - Bhutan - * `BO` - Bolivia - * `BQ` - Bonaire, Sint Eustatius and Saba - * `BA` - Bosnia and Herzegovina - * `BW` - Botswana - * `BV` - Bouvet Island - * `BR` - Brazil - * `IO` - British Indian Ocean Territory - * `BN` - Brunei - * `BG` - Bulgaria - * `BF` - Burkina Faso - * `BI` - Burundi - * `CV` - Cabo Verde - * `KH` - Cambodia - * `CM` - Cameroon - * `CA` - Canada - * `KY` - Cayman Islands - * `CF` - Central African Republic - * `TD` - Chad - * `CL` - Chile - * `CN` - China - * `CX` - Christmas Island - * `CC` - Cocos (Keeling) Islands - * `CO` - Colombia - * `KM` - Comoros - * `CG` - Congo - * `CD` - Congo (the Democratic Republic of the) - * `CK` - Cook Islands - * `CR` - Costa Rica - * `CI` - Côte d'Ivoire - * `HR` - Croatia - * `CU` - Cuba - * `CW` - Curaçao - * `CY` - Cyprus - * `CZ` - Czechia - * `DK` - Denmark - * `DJ` - Djibouti - * `DM` - Dominica - * `DO` - Dominican Republic - * `EC` - Ecuador - * `EG` - Egypt - * `SV` - El Salvador - * `GQ` - Equatorial Guinea - * `ER` - Eritrea - * `EE` - Estonia - * `SZ` - Eswatini - * `ET` - Ethiopia - * `FK` - Falkland Islands (Malvinas) - * `FO` - Faroe Islands - * `FJ` - Fiji - * `FI` - Finland - * `FR` - France - * `GF` - French Guiana - * `PF` - French Polynesia - * `TF` - French Southern Territories - * `GA` - Gabon - * `GM` - Gambia - * `GE` - Georgia - * `DE` - Germany - * `GH` - Ghana - * `GI` - Gibraltar - * `GR` - Greece - * `GL` - Greenland - * `GD` - Grenada - * `GP` - Guadeloupe - * `GU` - Guam - * `GT` - Guatemala - * `GG` - Guernsey - * `GN` - Guinea - * `GW` - Guinea-Bissau - * `GY` - Guyana - * `HT` - Haiti - * `HM` - Heard Island and McDonald Islands - * `VA` - Holy See - * `HN` - Honduras - * `HK` - Hong Kong - * `HU` - Hungary - * `IS` - Iceland - * `IN` - India - * `ID` - Indonesia - * `IR` - Iran - * `IQ` - Iraq - * `IE` - Ireland - * `IM` - Isle of Man - * `IL` - Israel - * `IT` - Italy - * `JM` - Jamaica - * `JP` - Japan - * `JE` - Jersey - * `JO` - Jordan - * `KZ` - Kazakhstan - * `KE` - Kenya - * `KI` - Kiribati - * `KW` - Kuwait - * `KG` - Kyrgyzstan - * `LA` - Laos - * `LV` - Latvia - * `LB` - Lebanon - * `LS` - Lesotho - * `LR` - Liberia - * `LY` - Libya - * `LI` - Liechtenstein - * `LT` - Lithuania - * `LU` - Luxembourg - * `MO` - Macao - * `MG` - Madagascar - * `MW` - Malawi - * `MY` - Malaysia - * `MV` - Maldives - * `ML` - Mali - * `MT` - Malta - * `MH` - Marshall Islands - * `MQ` - Martinique - * `MR` - Mauritania - * `MU` - Mauritius - * `YT` - Mayotte - * `MX` - Mexico - * `FM` - Micronesia (Federated States of) - * `MD` - Moldova - * `MC` - Monaco - * `MN` - Mongolia - * `ME` - Montenegro - * `MS` - Montserrat - * `MA` - Morocco - * `MZ` - Mozambique - * `MM` - Myanmar - * `NA` - Namibia - * `NR` - Nauru - * `NP` - Nepal - * `NL` - Netherlands - * `NC` - New Caledonia - * `NZ` - New Zealand - * `NI` - Nicaragua - * `NE` - Niger - * `NG` - Nigeria - * `NU` - Niue - * `NF` - Norfolk Island - * `KP` - North Korea - * `MK` - North Macedonia - * `MP` - Northern Mariana Islands - * `NO` - Norway - * `OM` - Oman - * `PK` - Pakistan - * `PW` - Palau - * `PS` - Palestine, State of - * `PA` - Panama - * `PG` - Papua New Guinea - * `PY` - Paraguay - * `PE` - Peru - * `PH` - Philippines - * `PN` - Pitcairn - * `PL` - Poland - * `PT` - Portugal - * `PR` - Puerto Rico - * `QA` - Qatar - * `RE` - Réunion - * `RO` - Romania - * `RU` - Russia - * `RW` - Rwanda - * `BL` - Saint Barthélemy - * `SH` - Saint Helena, Ascension and Tristan da Cunha - * `KN` - Saint Kitts and Nevis - * `LC` - Saint Lucia - * `MF` - Saint Martin (French part) - * `PM` - Saint Pierre and Miquelon - * `VC` - Saint Vincent and the Grenadines - * `WS` - Samoa - * `SM` - San Marino - * `ST` - Sao Tome and Principe - * `SA` - Saudi Arabia - * `SN` - Senegal - * `RS` - Serbia - * `SC` - Seychelles - * `SL` - Sierra Leone - * `SG` - Singapore - * `SX` - Sint Maarten (Dutch part) - * `SK` - Slovakia - * `SI` - Slovenia - * `SB` - Solomon Islands - * `SO` - Somalia - * `ZA` - South Africa - * `GS` - South Georgia and the South Sandwich Islands - * `KR` - South Korea - * `SS` - South Sudan - * `ES` - Spain - * `LK` - Sri Lanka - * `SD` - Sudan - * `SR` - Suriname - * `SJ` - Svalbard and Jan Mayen - * `SE` - Sweden - * `CH` - Switzerland - * `SY` - Syria - * `TW` - Taiwan - * `TJ` - Tajikistan - * `TZ` - Tanzania - * `TH` - Thailand - * `TL` - Timor-Leste - * `TG` - Togo - * `TK` - Tokelau - * `TO` - Tonga - * `TT` - Trinidad and Tobago - * `TN` - Tunisia - * `TR` - Turkey - * `TM` - Turkmenistan - * `TC` - Turks and Caicos Islands - * `TV` - Tuvalu - * `UG` - Uganda - * `UA` - Ukraine - * `AE` - United Arab Emirates - * `GB` - United Kingdom - * `UM` - United States Minor Outlying Islands - * `US` - United States of America - * `UY` - Uruguay - * `UZ` - Uzbekistan - * `VU` - Vanuatu - * `VE` - Venezuela - * `VN` - Vietnam - * `VG` - Virgin Islands (British) - * `VI` - Virgin Islands (U.S.) - * `WF` - Wallis and Futuna - * `EH` - Western Sahara - * `YE` - Yemen - * `ZM` - Zambia - * `ZW` - Zimbabwe - source: - openapi: openapi/openapi.yml - CreditNoteStatus: - discriminated: false - docs: |- - The credit note's status. - - * `SUBMITTED` - SUBMITTED - * `AUTHORIZED` - AUTHORIZED - * `PAID` - PAID + * `RUB` - Russian Ruble + + * `RUR` - Russian Ruble (1991–1998) + + * `RWF` - Rwandan Franc + + * `SVC` - Salvadoran Colón + + * `WST` - Samoan Tala + + * `SAR` - Saudi Riyal + + * `RSD` - Serbian Dinar + + * `CSD` - Serbian Dinar (2002–2006) + + * `SCR` - Seychellois Rupee + + * `SLL` - Sierra Leonean Leone + + * `XAG` - Silver + + * `SGD` - Singapore Dollar + + * `SKK` - Slovak Koruna + + * `SIT` - Slovenian Tolar + + * `SBD` - Solomon Islands Dollar + + * `SOS` - Somali Shilling + + * `ZAR` - South African Rand + + * `ZAL` - South African Rand (financial) + + * `KRH` - South Korean Hwan (1953–1962) + + * `KRW` - South Korean Won + + * `KRO` - South Korean Won (1945–1953) + + * `SSP` - South Sudanese Pound + + * `SUR` - Soviet Rouble + + * `ESP` - Spanish Peseta + + * `ESA` - Spanish Peseta (A account) + + * `ESB` - Spanish Peseta (convertible account) + + * `XDR` - Special Drawing Rights + + * `LKR` - Sri Lankan Rupee + + * `SHP` - St. Helena Pound + + * `XSU` - Sucre + + * `SDD` - Sudanese Dinar (1992–2007) + + * `SDG` - Sudanese Pound + + * `SDP` - Sudanese Pound (1957–1998) + + * `SRD` - Surinamese Dollar + + * `SRG` - Surinamese Guilder + + * `SZL` - Swazi Lilangeni + + * `SEK` - Swedish Krona + + * `CHF` - Swiss Franc + + * `SYP` - Syrian Pound + + * `STN` - São Tomé & Príncipe Dobra + + * `STD` - São Tomé & Príncipe Dobra (1977–2017) + + * `TVD` - TVD + + * `TJR` - Tajikistani Ruble + + * `TJS` - Tajikistani Somoni + + * `TZS` - Tanzanian Shilling + + * `XTS` - Testing Currency Code + + * `THB` - Thai Baht + + * `XXX` - The codes assigned for transactions where no currency is + involved + + * `TPE` - Timorese Escudo + + * `TOP` - Tongan Paʻanga + + * `TTD` - Trinidad & Tobago Dollar + + * `TND` - Tunisian Dinar + + * `TRY` - Turkish Lira + + * `TRL` - Turkish Lira (1922–2005) + + * `TMT` - Turkmenistani Manat + + * `TMM` - Turkmenistani Manat (1993–2009) + + * `USD` - US Dollar + + * `USN` - US Dollar (Next day) + + * `USS` - US Dollar (Same day) + + * `UGX` - Ugandan Shilling + + * `UGS` - Ugandan Shilling (1966–1987) + + * `UAH` - Ukrainian Hryvnia + + * `UAK` - Ukrainian Karbovanets + + * `AED` - United Arab Emirates Dirham + + * `UYW` - Uruguayan Nominal Wage Index Unit + + * `UYU` - Uruguayan Peso + + * `UYP` - Uruguayan Peso (1975–1993) + + * `UYI` - Uruguayan Peso (Indexed Units) + + * `UZS` - Uzbekistani Som + + * `VUV` - Vanuatu Vatu + + * `VES` - Venezuelan Bolívar + + * `VEB` - Venezuelan Bolívar (1871–2008) + + * `VEF` - Venezuelan Bolívar (2008–2018) + + * `VND` - Vietnamese Dong + + * `VNN` - Vietnamese Dong (1978–1985) + + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) union: - - CreditNoteStatusEnum + - TransactionCurrencyEnum - string source: openapi: openapi/openapi.yml inline: true - CreditNoteContact: - discriminated: false - docs: The credit note's contact. - union: - - type: string - validation: - format: uuid - - Contact - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteCompany: + BankFeedAccountRequestFeedStatus: discriminated: false - docs: The company the credit note belongs to. + docs: |- + The status of the bank feed. + + * `ACTIVE` - ACTIVE + * `INACTIVE` - INACTIVE union: - - type: string - validation: - format: uuid - - CompanyInfo + - FeedStatusEnum + - string source: openapi: openapi/openapi.yml inline: true - CreditNoteTrackingCategoriesItem: + BankFeedAccountRequestAccountType: discriminated: false + docs: |- + The type of the account. + + * `BANK` - BANK + * `CREDIT_CARD` - CREDIT_CARD union: - - type: string - validation: - format: uuid - - TrackingCategory + - BankFeedAccountAccountTypeEnum + - string source: openapi: openapi/openapi.yml inline: true - CreditNoteCurrency: - discriminated: false + BankFeedAccountRequest: docs: >- - The credit note's currency. + # The BankFeedAccount Object + ### Description - * `XUA` - ADB Unit of Account + The `BankFeedAccount` object represents a bank feed account, detailing + various attributes including account identifiers, names, currency, and + balance information. This object is central to managing and tracking bank + feed accounts within the system. - * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) + ### Usage Example - * `ALL` - Albanian Lek + Fetch from the `GET BankFeedAccount` endpoint to view details of a bank + feed account. + properties: + source_account_id: + type: optional + docs: >- + The unique identifier of the source account from our customer’s + platform. + validation: + maxLength: 1024 + target_account_id: + type: optional + docs: >- + The unique identifier of the target account from the third party + software. + validation: + maxLength: 1024 + source_account_name: + type: optional + docs: The name of the source account as stored in our customer’s platform. + validation: + maxLength: 1024 + source_account_number: + type: optional + docs: >- + The human-readable account number of the source account as stored in + our customer’s platform. + validation: + maxLength: 1024 + target_account_name: + type: optional + docs: The name of the target account from the third party software. + validation: + maxLength: 1024 + currency: + type: optional + docs: >- + The currency code of the bank feed. - * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar + * `XUA` - ADB Unit of Account - * `ADP` - Andorran Peseta + * `AFN` - Afghan Afghani - * `AOA` - Angolan Kwanza + * `AFA` - Afghan Afghani (1927–2002) - * `AOK` - Angolan Kwanza (1977–1991) + * `ALL` - Albanian Lek - * `AON` - Angolan New Kwanza (1990–2000) + * `ALK` - Albanian Lek (1946–1965) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `DZD` - Algerian Dinar - * `ARA` - Argentine Austral + * `ADP` - Andorran Peseta - * `ARS` - Argentine Peso + * `AOA` - Angolan Kwanza - * `ARM` - Argentine Peso (1881–1970) + * `AOK` - Angolan Kwanza (1977–1991) - * `ARP` - Argentine Peso (1983–1985) + * `AON` - Angolan New Kwanza (1990–2000) - * `ARL` - Argentine Peso Ley (1970–1983) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `AMD` - Armenian Dram + * `ARA` - Argentine Austral - * `AWG` - Aruban Florin + * `ARS` - Argentine Peso - * `AUD` - Australian Dollar + * `ARM` - Argentine Peso (1881–1970) - * `ATS` - Austrian Schilling + * `ARP` - Argentine Peso (1983–1985) - * `AZN` - Azerbaijani Manat + * `ARL` - Argentine Peso Ley (1970–1983) - * `AZM` - Azerbaijani Manat (1993–2006) + * `AMD` - Armenian Dram - * `BSD` - Bahamian Dollar + * `AWG` - Aruban Florin - * `BHD` - Bahraini Dinar + * `AUD` - Australian Dollar - * `BDT` - Bangladeshi Taka + * `ATS` - Austrian Schilling - * `BBD` - Barbadian Dollar + * `AZN` - Azerbaijani Manat - * `BYN` - Belarusian Ruble + * `AZM` - Azerbaijani Manat (1993–2006) - * `BYB` - Belarusian Ruble (1994–1999) + * `BSD` - Bahamian Dollar - * `BYR` - Belarusian Ruble (2000–2016) + * `BHD` - Bahraini Dinar - * `BEF` - Belgian Franc + * `BDT` - Bangladeshi Taka - * `BEC` - Belgian Franc (convertible) + * `BBD` - Barbadian Dollar - * `BEL` - Belgian Franc (financial) + * `BYN` - Belarusian Ruble - * `BZD` - Belize Dollar + * `BYB` - Belarusian Ruble (1994–1999) - * `BMD` - Bermudan Dollar + * `BYR` - Belarusian Ruble (2000–2016) - * `BTN` - Bhutanese Ngultrum + * `BEF` - Belgian Franc - * `BOB` - Bolivian Boliviano + * `BEC` - Belgian Franc (convertible) - * `BOL` - Bolivian Boliviano (1863–1963) + * `BEL` - Belgian Franc (financial) - * `BOV` - Bolivian Mvdol + * `BZD` - Belize Dollar - * `BOP` - Bolivian Peso + * `BMD` - Bermudan Dollar - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `BTN` - Bhutanese Ngultrum - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `BOB` - Bolivian Boliviano - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `BOL` - Bolivian Boliviano (1863–1963) - * `BWP` - Botswanan Pula + * `BOV` - Bolivian Mvdol - * `BRC` - Brazilian Cruzado (1986–1989) + * `BOP` - Bolivian Peso - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BRN` - Brazilian New Cruzado (1989–1990) + * `BWP` - Botswanan Pula - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `BRC` - Brazilian Cruzado (1986–1989) - * `BRL` - Brazilian Real + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `GBP` - British Pound + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BND` - Brunei Dollar + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BGL` - Bulgarian Hard Lev + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BGN` - Bulgarian Lev + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BGO` - Bulgarian Lev (1879–1952) + * `BRL` - Brazilian Real - * `BGM` - Bulgarian Socialist Lev + * `GBP` - British Pound - * `BUK` - Burmese Kyat + * `BND` - Brunei Dollar - * `BIF` - Burundian Franc + * `BGL` - Bulgarian Hard Lev - * `XPF` - CFP Franc + * `BGN` - Bulgarian Lev - * `KHR` - Cambodian Riel + * `BGO` - Bulgarian Lev (1879–1952) - * `CAD` - Canadian Dollar + * `BGM` - Bulgarian Socialist Lev - * `CVE` - Cape Verdean Escudo + * `BUK` - Burmese Kyat - * `KYD` - Cayman Islands Dollar + * `BIF` - Burundian Franc - * `XAF` - Central African CFA Franc + * `XPF` - CFP Franc - * `CLE` - Chilean Escudo + * `KHR` - Cambodian Riel - * `CLP` - Chilean Peso + * `CAD` - Canadian Dollar - * `CLF` - Chilean Unit of Account (UF) + * `CVE` - Cape Verdean Escudo - * `CNX` - Chinese People’s Bank Dollar + * `KYD` - Cayman Islands Dollar - * `CNY` - Chinese Yuan + * `XAF` - Central African CFA Franc - * `CNH` - Chinese Yuan (offshore) + * `CLE` - Chilean Escudo - * `COP` - Colombian Peso + * `CLP` - Chilean Peso - * `COU` - Colombian Real Value Unit + * `CLF` - Chilean Unit of Account (UF) - * `KMF` - Comorian Franc + * `CNX` - Chinese People’s Bank Dollar - * `CDF` - Congolese Franc + * `CNY` - Chinese Yuan - * `CRC` - Costa Rican Colón + * `CNH` - Chinese Yuan (offshore) - * `HRD` - Croatian Dinar + * `COP` - Colombian Peso - * `HRK` - Croatian Kuna + * `COU` - Colombian Real Value Unit - * `CUC` - Cuban Convertible Peso + * `KMF` - Comorian Franc - * `CUP` - Cuban Peso + * `CDF` - Congolese Franc - * `CYP` - Cypriot Pound + * `CRC` - Costa Rican Colón - * `CZK` - Czech Koruna + * `HRD` - Croatian Dinar - * `CSK` - Czechoslovak Hard Koruna + * `HRK` - Croatian Kuna - * `DKK` - Danish Krone + * `CUC` - Cuban Convertible Peso - * `DJF` - Djiboutian Franc + * `CUP` - Cuban Peso - * `DOP` - Dominican Peso + * `CYP` - Cypriot Pound - * `NLG` - Dutch Guilder + * `CZK` - Czech Koruna - * `XCD` - East Caribbean Dollar + * `CSK` - Czechoslovak Hard Koruna - * `DDM` - East German Mark + * `DKK` - Danish Krone - * `ECS` - Ecuadorian Sucre + * `DJF` - Djiboutian Franc - * `ECV` - Ecuadorian Unit of Constant Value + * `DOP` - Dominican Peso - * `EGP` - Egyptian Pound + * `NLG` - Dutch Guilder - * `GQE` - Equatorial Guinean Ekwele + * `XCD` - East Caribbean Dollar - * `ERN` - Eritrean Nakfa + * `DDM` - East German Mark - * `EEK` - Estonian Kroon + * `ECS` - Ecuadorian Sucre - * `ETB` - Ethiopian Birr + * `ECV` - Ecuadorian Unit of Constant Value - * `EUR` - Euro + * `EGP` - Egyptian Pound - * `XBA` - European Composite Unit + * `GQE` - Equatorial Guinean Ekwele - * `XEU` - European Currency Unit + * `ERN` - Eritrean Nakfa - * `XBB` - European Monetary Unit + * `EEK` - Estonian Kroon - * `XBC` - European Unit of Account (XBC) + * `ETB` - Ethiopian Birr - * `XBD` - European Unit of Account (XBD) + * `EUR` - Euro - * `FKP` - Falkland Islands Pound + * `XBA` - European Composite Unit - * `FJD` - Fijian Dollar + * `XEU` - European Currency Unit - * `FIM` - Finnish Markka + * `XBB` - European Monetary Unit - * `FRF` - French Franc + * `XBC` - European Unit of Account (XBC) - * `XFO` - French Gold Franc + * `XBD` - European Unit of Account (XBD) - * `XFU` - French UIC-Franc + * `FKP` - Falkland Islands Pound + + * `FJD` - Fijian Dollar + + * `FIM` - Finnish Markka + + * `FRF` - French Franc + + * `XFO` - French Gold Franc + + * `XFU` - French UIC-Franc + + * `GMD` - Gambian Dalasi + + * `GEK` - Georgian Kupon Larit + + * `GEL` - Georgian Lari + + * `DEM` - German Mark + + * `GHS` - Ghanaian Cedi + + * `GHC` - Ghanaian Cedi (1979–2007) + + * `GIP` - Gibraltar Pound + + * `XAU` - Gold + + * `GRD` - Greek Drachma - * `GMD` - Gambian Dalasi + * `GTQ` - Guatemalan Quetzal - * `GEK` - Georgian Kupon Larit + * `GWP` - Guinea-Bissau Peso - * `GEL` - Georgian Lari + * `GNF` - Guinean Franc - * `DEM` - German Mark + * `GNS` - Guinean Syli - * `GHS` - Ghanaian Cedi + * `GYD` - Guyanaese Dollar - * `GHC` - Ghanaian Cedi (1979–2007) + * `HTG` - Haitian Gourde - * `GIP` - Gibraltar Pound + * `HNL` - Honduran Lempira - * `XAU` - Gold + * `HKD` - Hong Kong Dollar - * `GRD` - Greek Drachma + * `HUF` - Hungarian Forint - * `GTQ` - Guatemalan Quetzal + * `IMP` - IMP - * `GWP` - Guinea-Bissau Peso + * `ISK` - Icelandic Króna - * `GNF` - Guinean Franc + * `ISJ` - Icelandic Króna (1918–1981) - * `GNS` - Guinean Syli + * `INR` - Indian Rupee - * `GYD` - Guyanaese Dollar + * `IDR` - Indonesian Rupiah - * `HTG` - Haitian Gourde + * `IRR` - Iranian Rial - * `HNL` - Honduran Lempira + * `IQD` - Iraqi Dinar - * `HKD` - Hong Kong Dollar + * `IEP` - Irish Pound - * `HUF` - Hungarian Forint + * `ILS` - Israeli New Shekel - * `IMP` - IMP + * `ILP` - Israeli Pound - * `ISK` - Icelandic Króna + * `ILR` - Israeli Shekel (1980–1985) - * `ISJ` - Icelandic Króna (1918–1981) + * `ITL` - Italian Lira - * `INR` - Indian Rupee + * `JMD` - Jamaican Dollar - * `IDR` - Indonesian Rupiah + * `JPY` - Japanese Yen - * `IRR` - Iranian Rial + * `JOD` - Jordanian Dinar - * `IQD` - Iraqi Dinar + * `KZT` - Kazakhstani Tenge - * `IEP` - Irish Pound + * `KES` - Kenyan Shilling - * `ILS` - Israeli New Shekel + * `KWD` - Kuwaiti Dinar - * `ILP` - Israeli Pound + * `KGS` - Kyrgystani Som - * `ILR` - Israeli Shekel (1980–1985) + * `LAK` - Laotian Kip - * `ITL` - Italian Lira + * `LVL` - Latvian Lats - * `JMD` - Jamaican Dollar + * `LVR` - Latvian Ruble - * `JPY` - Japanese Yen + * `LBP` - Lebanese Pound - * `JOD` - Jordanian Dinar + * `LSL` - Lesotho Loti - * `KZT` - Kazakhstani Tenge + * `LRD` - Liberian Dollar - * `KES` - Kenyan Shilling + * `LYD` - Libyan Dinar - * `KWD` - Kuwaiti Dinar + * `LTL` - Lithuanian Litas - * `KGS` - Kyrgystani Som + * `LTT` - Lithuanian Talonas - * `LAK` - Laotian Kip + * `LUL` - Luxembourg Financial Franc - * `LVL` - Latvian Lats + * `LUC` - Luxembourgian Convertible Franc - * `LVR` - Latvian Ruble + * `LUF` - Luxembourgian Franc - * `LBP` - Lebanese Pound + * `MOP` - Macanese Pataca - * `LSL` - Lesotho Loti + * `MKD` - Macedonian Denar - * `LRD` - Liberian Dollar + * `MKN` - Macedonian Denar (1992–1993) - * `LYD` - Libyan Dinar + * `MGA` - Malagasy Ariary - * `LTL` - Lithuanian Litas + * `MGF` - Malagasy Franc - * `LTT` - Lithuanian Talonas + * `MWK` - Malawian Kwacha - * `LUL` - Luxembourg Financial Franc + * `MYR` - Malaysian Ringgit - * `LUC` - Luxembourgian Convertible Franc + * `MVR` - Maldivian Rufiyaa - * `LUF` - Luxembourgian Franc + * `MVP` - Maldivian Rupee (1947–1981) - * `MOP` - Macanese Pataca + * `MLF` - Malian Franc - * `MKD` - Macedonian Denar + * `MTL` - Maltese Lira - * `MKN` - Macedonian Denar (1992–1993) + * `MTP` - Maltese Pound - * `MGA` - Malagasy Ariary + * `MRU` - Mauritanian Ouguiya - * `MGF` - Malagasy Franc + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MWK` - Malawian Kwacha + * `MUR` - Mauritian Rupee - * `MYR` - Malaysian Ringgit + * `MXV` - Mexican Investment Unit - * `MVR` - Maldivian Rufiyaa + * `MXN` - Mexican Peso - * `MVP` - Maldivian Rupee (1947–1981) + * `MXP` - Mexican Silver Peso (1861–1992) - * `MLF` - Malian Franc + * `MDC` - Moldovan Cupon - * `MTL` - Maltese Lira + * `MDL` - Moldovan Leu - * `MTP` - Maltese Pound + * `MCF` - Monegasque Franc - * `MRU` - Mauritanian Ouguiya + * `MNT` - Mongolian Tugrik - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `MAD` - Moroccan Dirham - * `MUR` - Mauritian Rupee + * `MAF` - Moroccan Franc - * `MXV` - Mexican Investment Unit + * `MZE` - Mozambican Escudo - * `MXN` - Mexican Peso + * `MZN` - Mozambican Metical - * `MXP` - Mexican Silver Peso (1861–1992) + * `MZM` - Mozambican Metical (1980–2006) - * `MDC` - Moldovan Cupon + * `MMK` - Myanmar Kyat - * `MDL` - Moldovan Leu + * `NAD` - Namibian Dollar - * `MCF` - Monegasque Franc + * `NPR` - Nepalese Rupee - * `MNT` - Mongolian Tugrik + * `ANG` - Netherlands Antillean Guilder - * `MAD` - Moroccan Dirham + * `TWD` - New Taiwan Dollar - * `MAF` - Moroccan Franc + * `NZD` - New Zealand Dollar - * `MZE` - Mozambican Escudo + * `NIO` - Nicaraguan Córdoba - * `MZN` - Mozambican Metical + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `MZM` - Mozambican Metical (1980–2006) + * `NGN` - Nigerian Naira - * `MMK` - Myanmar Kyat + * `KPW` - North Korean Won - * `NAD` - Namibian Dollar + * `NOK` - Norwegian Krone - * `NPR` - Nepalese Rupee + * `OMR` - Omani Rial - * `ANG` - Netherlands Antillean Guilder + * `PKR` - Pakistani Rupee - * `TWD` - New Taiwan Dollar + * `XPD` - Palladium - * `NZD` - New Zealand Dollar + * `PAB` - Panamanian Balboa - * `NIO` - Nicaraguan Córdoba + * `PGK` - Papua New Guinean Kina - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `PYG` - Paraguayan Guarani - * `NGN` - Nigerian Naira + * `PEI` - Peruvian Inti - * `KPW` - North Korean Won + * `PEN` - Peruvian Sol - * `NOK` - Norwegian Krone + * `PES` - Peruvian Sol (1863–1965) - * `OMR` - Omani Rial + * `PHP` - Philippine Peso - * `PKR` - Pakistani Rupee + * `XPT` - Platinum - * `XPD` - Palladium + * `PLN` - Polish Zloty - * `PAB` - Panamanian Balboa + * `PLZ` - Polish Zloty (1950–1995) - * `PGK` - Papua New Guinean Kina + * `PTE` - Portuguese Escudo - * `PYG` - Paraguayan Guarani + * `GWE` - Portuguese Guinea Escudo - * `PEI` - Peruvian Inti + * `QAR` - Qatari Rial - * `PEN` - Peruvian Sol + * `XRE` - RINET Funds - * `PES` - Peruvian Sol (1863–1965) + * `RHD` - Rhodesian Dollar - * `PHP` - Philippine Peso + * `RON` - Romanian Leu - * `XPT` - Platinum + * `ROL` - Romanian Leu (1952–2006) - * `PLN` - Polish Zloty + * `RUB` - Russian Ruble - * `PLZ` - Polish Zloty (1950–1995) + * `RUR` - Russian Ruble (1991–1998) - * `PTE` - Portuguese Escudo + * `RWF` - Rwandan Franc - * `GWE` - Portuguese Guinea Escudo + * `SVC` - Salvadoran Colón - * `QAR` - Qatari Rial + * `WST` - Samoan Tala - * `XRE` - RINET Funds + * `SAR` - Saudi Riyal - * `RHD` - Rhodesian Dollar + * `RSD` - Serbian Dinar - * `RON` - Romanian Leu + * `CSD` - Serbian Dinar (2002–2006) - * `ROL` - Romanian Leu (1952–2006) + * `SCR` - Seychellois Rupee - * `RUB` - Russian Ruble + * `SLL` - Sierra Leonean Leone - * `RUR` - Russian Ruble (1991–1998) + * `XAG` - Silver - * `RWF` - Rwandan Franc + * `SGD` - Singapore Dollar - * `SVC` - Salvadoran Colón + * `SKK` - Slovak Koruna - * `WST` - Samoan Tala + * `SIT` - Slovenian Tolar - * `SAR` - Saudi Riyal + * `SBD` - Solomon Islands Dollar - * `RSD` - Serbian Dinar + * `SOS` - Somali Shilling - * `CSD` - Serbian Dinar (2002–2006) + * `ZAR` - South African Rand - * `SCR` - Seychellois Rupee + * `ZAL` - South African Rand (financial) - * `SLL` - Sierra Leonean Leone + * `KRH` - South Korean Hwan (1953–1962) - * `XAG` - Silver + * `KRW` - South Korean Won - * `SGD` - Singapore Dollar + * `KRO` - South Korean Won (1945–1953) - * `SKK` - Slovak Koruna + * `SSP` - South Sudanese Pound - * `SIT` - Slovenian Tolar + * `SUR` - Soviet Rouble - * `SBD` - Solomon Islands Dollar + * `ESP` - Spanish Peseta - * `SOS` - Somali Shilling + * `ESA` - Spanish Peseta (A account) - * `ZAR` - South African Rand + * `ESB` - Spanish Peseta (convertible account) - * `ZAL` - South African Rand (financial) + * `XDR` - Special Drawing Rights - * `KRH` - South Korean Hwan (1953–1962) + * `LKR` - Sri Lankan Rupee - * `KRW` - South Korean Won + * `SHP` - St. Helena Pound - * `KRO` - South Korean Won (1945–1953) + * `XSU` - Sucre - * `SSP` - South Sudanese Pound + * `SDD` - Sudanese Dinar (1992–2007) - * `SUR` - Soviet Rouble + * `SDG` - Sudanese Pound - * `ESP` - Spanish Peseta + * `SDP` - Sudanese Pound (1957–1998) - * `ESA` - Spanish Peseta (A account) + * `SRD` - Surinamese Dollar - * `ESB` - Spanish Peseta (convertible account) + * `SRG` - Surinamese Guilder - * `XDR` - Special Drawing Rights + * `SZL` - Swazi Lilangeni - * `LKR` - Sri Lankan Rupee + * `SEK` - Swedish Krona - * `SHP` - St. Helena Pound + * `CHF` - Swiss Franc - * `XSU` - Sucre + * `SYP` - Syrian Pound - * `SDD` - Sudanese Dinar (1992–2007) + * `STN` - São Tomé & Príncipe Dobra - * `SDG` - Sudanese Pound + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `SDP` - Sudanese Pound (1957–1998) + * `TVD` - TVD - * `SRD` - Surinamese Dollar + * `TJR` - Tajikistani Ruble - * `SRG` - Surinamese Guilder + * `TJS` - Tajikistani Somoni - * `SZL` - Swazi Lilangeni + * `TZS` - Tanzanian Shilling - * `SEK` - Swedish Krona + * `XTS` - Testing Currency Code - * `CHF` - Swiss Franc + * `THB` - Thai Baht - * `SYP` - Syrian Pound + * `XXX` - The codes assigned for transactions where no currency is + involved - * `STN` - São Tomé & Príncipe Dobra + * `TPE` - Timorese Escudo - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `TOP` - Tongan Paʻanga - * `TVD` - TVD + * `TTD` - Trinidad & Tobago Dollar - * `TJR` - Tajikistani Ruble + * `TND` - Tunisian Dinar - * `TJS` - Tajikistani Somoni + * `TRY` - Turkish Lira - * `TZS` - Tanzanian Shilling + * `TRL` - Turkish Lira (1922–2005) - * `XTS` - Testing Currency Code + * `TMT` - Turkmenistani Manat - * `THB` - Thai Baht + * `TMM` - Turkmenistani Manat (1993–2009) - * `XXX` - The codes assigned for transactions where no currency is - involved + * `USD` - US Dollar - * `TPE` - Timorese Escudo + * `USN` - US Dollar (Next day) - * `TOP` - Tongan Paʻanga + * `USS` - US Dollar (Same day) - * `TTD` - Trinidad & Tobago Dollar + * `UGX` - Ugandan Shilling - * `TND` - Tunisian Dinar + * `UGS` - Ugandan Shilling (1966–1987) - * `TRY` - Turkish Lira + * `UAH` - Ukrainian Hryvnia - * `TRL` - Turkish Lira (1922–2005) + * `UAK` - Ukrainian Karbovanets - * `TMT` - Turkmenistani Manat + * `AED` - United Arab Emirates Dirham - * `TMM` - Turkmenistani Manat (1993–2009) + * `UYW` - Uruguayan Nominal Wage Index Unit - * `USD` - US Dollar + * `UYU` - Uruguayan Peso - * `USN` - US Dollar (Next day) + * `UYP` - Uruguayan Peso (1975–1993) - * `USS` - US Dollar (Same day) + * `UYI` - Uruguayan Peso (Indexed Units) - * `UGX` - Ugandan Shilling + * `UZS` - Uzbekistani Som - * `UGS` - Ugandan Shilling (1966–1987) + * `VUV` - Vanuatu Vatu - * `UAH` - Ukrainian Hryvnia + * `VES` - Venezuelan Bolívar - * `UAK` - Ukrainian Karbovanets + * `VEB` - Venezuelan Bolívar (1871–2008) - * `AED` - United Arab Emirates Dirham + * `VEF` - Venezuelan Bolívar (2008–2018) - * `UYW` - Uruguayan Nominal Wage Index Unit + * `VND` - Vietnamese Dong - * `UYU` - Uruguayan Peso + * `VNN` - Vietnamese Dong (1978–1985) - * `UYP` - Uruguayan Peso (1975–1993) + * `CHE` - WIR Euro - * `UYI` - Uruguayan Peso (Indexed Units) + * `CHW` - WIR Franc - * `UZS` - Uzbekistani Som + * `XOF` - West African CFA Franc - * `VUV` - Vanuatu Vatu + * `YDD` - Yemeni Dinar - * `VES` - Venezuelan Bolívar + * `YER` - Yemeni Rial - * `VEB` - Venezuelan Bolívar (1871–2008) + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `VEF` - Venezuelan Bolívar (2008–2018) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `VND` - Vietnamese Dong + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `VNN` - Vietnamese Dong (1978–1985) + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `CHE` - WIR Euro + * `ZWN` - ZWN - * `CHW` - WIR Franc + * `ZRN` - Zairean New Zaire (1993–1998) - * `XOF` - West African CFA Franc + * `ZRZ` - Zairean Zaire (1971–1993) - * `YDD` - Yemeni Dinar + * `ZMW` - Zambian Kwacha - * `YER` - Yemeni Rial + * `ZMK` - Zambian Kwacha (1968–2012) - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `ZWR` - Zimbabwean Dollar (2008) - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `ZWL` - Zimbabwean Dollar (2009) + feed_status: + type: optional + docs: |- + The status of the bank feed. - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `ACTIVE` - ACTIVE + * `INACTIVE` - INACTIVE + feed_start_date: + type: optional + docs: The start date of the bank feed’s transactions. + source_account_balance: + type: optional + docs: The current balance of funds in the source account. + account_type: + type: optional + docs: |- + The type of the account. - * `ZWN` - ZWN + * `BANK` - BANK + * `CREDIT_CARD` - CREDIT_CARD + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + BankFeedAccountResponse: + properties: + model: BankFeedAccount + warnings: list + errors: list + logs: optional> + source: + openapi: openapi/openapi.yml + BankFeedTransactionBankFeedAccount: + discriminated: false + docs: The bank feed account associated with the transaction. + union: + - type: string + validation: + format: uuid + - BankFeedAccount + source: + openapi: openapi/openapi.yml + inline: true + BankFeedTransactionCreditOrDebit: + discriminated: false + docs: |- + If the transaction is of type debit or credit. - * `ZRN` - Zairean New Zaire (1993–1998) + * `CREDIT` - CREDIT + * `DEBIT` - DEBIT + union: + - CreditOrDebitEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + BankFeedTransaction: + docs: >- + # The BankFeedTransaction Object - * `ZRZ` - Zairean Zaire (1971–1993) + ### Description - * `ZMW` - Zambian Kwacha + The `BankFeedTransaction` object is used to represent transactions linked + to a bank feed account. This includes details about the transaction such + as the date, amount, description, and type. - * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) + ### Usage Example - * `ZWR` - Zimbabwean Dollar (2008) + Fetch from the `GET BankFeedTransaction` endpoint to view details of a + transaction associated with a bank feed account. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + bank_feed_account: + type: optional + docs: The bank feed account associated with the transaction. + transaction_date: + type: optional + docs: The date that the transaction occurred. + posted_date: + type: optional + docs: The date the transaction was posted to the bank account. + amount: + type: optional + docs: The amount of the transaction. + description: + type: optional + docs: The description of the transaction. + validation: + maxLength: 1024 + transaction_type: + type: optional + docs: The underlying type of the transaction. + validation: + maxLength: 1024 + payee: + type: optional + docs: >- + The person or merchant who initiated the transaction, or + alternatively, to whom the transaction was paid. + validation: + maxLength: 1024 + credit_or_debit: + type: optional + docs: |- + If the transaction is of type debit or credit. - * `ZWL` - Zimbabwean Dollar (2009) - union: - - TransactionCurrencyEnum - - string + * `CREDIT` - CREDIT + * `DEBIT` - DEBIT + source_transaction_id: + type: optional + docs: The customer’s identifier for the transaction. + validation: + maxLength: 1024 + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + is_processed: + type: optional + docs: >- + Whether or not this transaction has been processed by the external + system. For example, NetSuite writes this field as True when the + SuiteApp has processed the transaction. + access: read-only source: openapi: openapi/openapi.yml - inline: true - CreditNotePaymentsItem: + BankFeedTransactionRequestRequestBankFeedAccount: discriminated: false + docs: The bank feed account associated with the transaction. union: - type: string validation: format: uuid - - Payment + - BankFeedAccount source: openapi: openapi/openapi.yml inline: true - CreditNoteAppliedPaymentsItem: + BankFeedTransactionRequestRequestCreditOrDebit: discriminated: false + docs: |- + If the transaction is of type debit or credit. + + * `CREDIT` - CREDIT + * `DEBIT` - DEBIT union: - - type: string - validation: - format: uuid - - PaymentLineItem + - CreditOrDebitEnum + - string source: openapi: openapi/openapi.yml inline: true - CreditNoteAccountingPeriod: + BankFeedTransactionRequestRequest: + docs: >- + # The BankFeedTransaction Object + + ### Description + + The `BankFeedTransaction` object is used to represent transactions linked + to a bank feed account. This includes details about the transaction such + as the date, amount, description, and type. + + + ### Usage Example + + Fetch from the `GET BankFeedTransaction` endpoint to view details of a + transaction associated with a bank feed account. + properties: + bank_feed_account: + type: optional + docs: The bank feed account associated with the transaction. + transaction_date: + type: optional + docs: The date that the transaction occurred. + posted_date: + type: optional + docs: The date the transaction was posted to the bank account. + amount: + type: optional + docs: The amount of the transaction. + description: + type: optional + docs: The description of the transaction. + validation: + maxLength: 1024 + transaction_type: + type: optional + docs: The underlying type of the transaction. + validation: + maxLength: 1024 + payee: + type: optional + docs: >- + The person or merchant who initiated the transaction, or + alternatively, to whom the transaction was paid. + validation: + maxLength: 1024 + credit_or_debit: + type: optional + docs: |- + If the transaction is of type debit or credit. + + * `CREDIT` - CREDIT + * `DEBIT` - DEBIT + source_transaction_id: + type: optional + docs: The customer’s identifier for the transaction. + validation: + maxLength: 1024 + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + BankFeedTransactionResponse: + properties: + model: BankFeedTransaction + warnings: list + errors: list + logs: optional> + source: + openapi: openapi/openapi.yml + CashFlowStatementCompany: discriminated: false - docs: The accounting period that the CreditNote was generated in. + docs: The company the cash flow statement belongs to. union: - type: string validation: format: uuid - - AccountingPeriod + - CompanyInfo source: openapi: openapi/openapi.yml inline: true - CreditNote: + CashFlowStatement: docs: >- - # The CreditNote Object + # The CashFlowStatement Object ### Description - A `CreditNote` is transaction issued to a customer, indicating a reduction - or cancellation of the amount owed by the customer. It is most generally - used as an adjustment note used to rectify errors, returns, or - overpayments related to a sales transaction. A `CreditNote` can be applied - to *Accounts Receivable* Invoices to decrease the overall amount of the - Invoice. + The `CashFlowStatement` object shows operating activities, investing + activities, and financing activities over a period of time (month, + quarter, or year). ### Usage Example - Fetch from the `LIST CreditNotes` endpoint and view a company's credit - notes. + Fetch from the `LIST CashFlowStatements` endpoint and view a company's + cash flow statements. properties: id: type: optional @@ -13336,915 +7937,778 @@ types: type: optional docs: The datetime that this object was modified by Merge. access: read-only - transaction_date: - type: optional - docs: The credit note's transaction date. - status: - type: optional - docs: |- - The credit note's status. - - * `SUBMITTED` - SUBMITTED - * `AUTHORIZED` - AUTHORIZED - * `PAID` - PAID - number: + name: type: optional - docs: The credit note's number. - contact: - type: optional - docs: The credit note's contact. + docs: The cash flow statement's name. + currency: optional company: - type: optional - docs: The company the credit note belongs to. - exchange_rate: - type: optional - docs: The credit note's exchange rate. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - total_amount: + type: optional + docs: The company the cash flow statement belongs to. + start_period: + type: optional + docs: The cash flow statement's start period. + end_period: + type: optional + docs: The cash flow statement's end period. + cash_at_beginning_of_period: type: optional - docs: The credit note's total amount. - remaining_credit: + docs: >- + Cash and cash equivalents at the beginning of the cash flow + statement's period. + cash_at_end_of_period: type: optional docs: >- - The amount of value remaining in the credit note that the customer can - use. - inclusive_of_tax: + Cash and cash equivalents at the beginning of the cash flow + statement's period. + operating_activities: + type: optional> + access: read-only + investing_activities: + type: optional> + access: read-only + financing_activities: + type: optional> + access: read-only + remote_generated_at: + type: optional + docs: >- + The time that cash flow statement was generated by the accounting + system. + remote_was_deleted: type: optional docs: >- - If the transaction is inclusive or exclusive of tax. `True` if - inclusive, `False` if exclusive. - line_items: - type: optional> + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). access: read-only - tracking_categories: optional>> - currency: - type: optional - docs: >- - The credit note's currency. - - - * `XUA` - ADB Unit of Account - - * `AFN` - Afghan Afghani - - * `AFA` - Afghan Afghani (1927–2002) - - * `ALL` - Albanian Lek - - * `ALK` - Albanian Lek (1946–1965) - - * `DZD` - Algerian Dinar - - * `ADP` - Andorran Peseta - - * `AOA` - Angolan Kwanza - - * `AOK` - Angolan Kwanza (1977–1991) - - * `AON` - Angolan New Kwanza (1990–2000) - - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - - * `ARA` - Argentine Austral - - * `ARS` - Argentine Peso - - * `ARM` - Argentine Peso (1881–1970) - - * `ARP` - Argentine Peso (1983–1985) - - * `ARL` - Argentine Peso Ley (1970–1983) - - * `AMD` - Armenian Dram - - * `AWG` - Aruban Florin - - * `AUD` - Australian Dollar - - * `ATS` - Austrian Schilling - - * `AZN` - Azerbaijani Manat - - * `AZM` - Azerbaijani Manat (1993–2006) - - * `BSD` - Bahamian Dollar - - * `BHD` - Bahraini Dinar - - * `BDT` - Bangladeshi Taka - - * `BBD` - Barbadian Dollar - - * `BYN` - Belarusian Ruble - - * `BYB` - Belarusian Ruble (1994–1999) - - * `BYR` - Belarusian Ruble (2000–2016) - - * `BEF` - Belgian Franc - - * `BEC` - Belgian Franc (convertible) - - * `BEL` - Belgian Franc (financial) - - * `BZD` - Belize Dollar - - * `BMD` - Bermudan Dollar - - * `BTN` - Bhutanese Ngultrum - - * `BOB` - Bolivian Boliviano - - * `BOL` - Bolivian Boliviano (1863–1963) + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + CategoriesEnum: + enum: + - hris + - ats + - accounting + - ticketing + - crm + - mktg + - filestorage + docs: |- + * `hris` - hris + * `ats` - ats + * `accounting` - accounting + * `ticketing` - ticketing + * `crm` - crm + * `mktg` - mktg + * `filestorage` - filestorage + source: + openapi: openapi/openapi.yml + CategoryEnum: + enum: + - hris + - ats + - accounting + - ticketing + - crm + - mktg + - filestorage + docs: |- + * `hris` - hris + * `ats` - ats + * `accounting` - accounting + * `ticketing` - ticketing + * `crm` - crm + * `mktg` - mktg + * `filestorage` - filestorage + source: + openapi: openapi/openapi.yml + CategoryTypeEnum: + enum: + - CLASS + - DEPARTMENT + docs: |- + * `CLASS` - CLASS + * `DEPARTMENT` - DEPARTMENT + source: + openapi: openapi/openapi.yml + ClassificationEnum: + enum: + - ASSET + - EQUITY + - EXPENSE + - LIABILITY + - REVENUE + docs: |- + * `ASSET` - ASSET + * `EQUITY` - EQUITY + * `EXPENSE` - EXPENSE + * `LIABILITY` - LIABILITY + * `REVENUE` - REVENUE + source: + openapi: openapi/openapi.yml + CommonModelScopeApi: + properties: + common_models: + docs: The common models you want to update the scopes for + type: list + source: + openapi: openapi/openapi.yml + CommonModelScopesBodyRequest: + properties: + model_id: + type: string + validation: + minLength: 1 + enabled_actions: list + disabled_fields: list + source: + openapi: openapi/openapi.yml + CompanyInfoCurrency: + discriminated: false + docs: >- + The currency set in the company's accounting platform. - * `BOV` - Bolivian Mvdol - * `BOP` - Bolivian Peso + * `XUA` - ADB Unit of Account - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `AFN` - Afghan Afghani - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `AFA` - Afghan Afghani (1927–2002) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `ALL` - Albanian Lek - * `BWP` - Botswanan Pula + * `ALK` - Albanian Lek (1946–1965) - * `BRC` - Brazilian Cruzado (1986–1989) + * `DZD` - Algerian Dinar - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `ADP` - Andorran Peseta - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `AOA` - Angolan Kwanza - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `AOK` - Angolan Kwanza (1977–1991) - * `BRN` - Brazilian New Cruzado (1989–1990) + * `AON` - Angolan New Kwanza (1990–2000) - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `BRL` - Brazilian Real + * `ARA` - Argentine Austral - * `GBP` - British Pound + * `ARS` - Argentine Peso - * `BND` - Brunei Dollar + * `ARM` - Argentine Peso (1881–1970) - * `BGL` - Bulgarian Hard Lev + * `ARP` - Argentine Peso (1983–1985) - * `BGN` - Bulgarian Lev + * `ARL` - Argentine Peso Ley (1970–1983) - * `BGO` - Bulgarian Lev (1879–1952) + * `AMD` - Armenian Dram - * `BGM` - Bulgarian Socialist Lev + * `AWG` - Aruban Florin - * `BUK` - Burmese Kyat + * `AUD` - Australian Dollar - * `BIF` - Burundian Franc + * `ATS` - Austrian Schilling - * `XPF` - CFP Franc + * `AZN` - Azerbaijani Manat - * `KHR` - Cambodian Riel + * `AZM` - Azerbaijani Manat (1993–2006) - * `CAD` - Canadian Dollar + * `BSD` - Bahamian Dollar - * `CVE` - Cape Verdean Escudo + * `BHD` - Bahraini Dinar - * `KYD` - Cayman Islands Dollar + * `BDT` - Bangladeshi Taka - * `XAF` - Central African CFA Franc + * `BBD` - Barbadian Dollar - * `CLE` - Chilean Escudo + * `BYN` - Belarusian Ruble - * `CLP` - Chilean Peso + * `BYB` - Belarusian Ruble (1994–1999) - * `CLF` - Chilean Unit of Account (UF) + * `BYR` - Belarusian Ruble (2000–2016) - * `CNX` - Chinese People’s Bank Dollar + * `BEF` - Belgian Franc - * `CNY` - Chinese Yuan + * `BEC` - Belgian Franc (convertible) - * `CNH` - Chinese Yuan (offshore) + * `BEL` - Belgian Franc (financial) - * `COP` - Colombian Peso + * `BZD` - Belize Dollar - * `COU` - Colombian Real Value Unit + * `BMD` - Bermudan Dollar - * `KMF` - Comorian Franc + * `BTN` - Bhutanese Ngultrum - * `CDF` - Congolese Franc + * `BOB` - Bolivian Boliviano - * `CRC` - Costa Rican Colón + * `BOL` - Bolivian Boliviano (1863–1963) - * `HRD` - Croatian Dinar + * `BOV` - Bolivian Mvdol - * `HRK` - Croatian Kuna + * `BOP` - Bolivian Peso - * `CUC` - Cuban Convertible Peso + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `CUP` - Cuban Peso + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `CYP` - Cypriot Pound + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `CZK` - Czech Koruna + * `BWP` - Botswanan Pula - * `CSK` - Czechoslovak Hard Koruna + * `BRC` - Brazilian Cruzado (1986–1989) - * `DKK` - Danish Krone + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `DJF` - Djiboutian Franc + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `DOP` - Dominican Peso + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `NLG` - Dutch Guilder + * `BRN` - Brazilian New Cruzado (1989–1990) - * `XCD` - East Caribbean Dollar + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `DDM` - East German Mark + * `BRL` - Brazilian Real - * `ECS` - Ecuadorian Sucre + * `GBP` - British Pound - * `ECV` - Ecuadorian Unit of Constant Value + * `BND` - Brunei Dollar - * `EGP` - Egyptian Pound + * `BGL` - Bulgarian Hard Lev - * `GQE` - Equatorial Guinean Ekwele + * `BGN` - Bulgarian Lev - * `ERN` - Eritrean Nakfa + * `BGO` - Bulgarian Lev (1879–1952) - * `EEK` - Estonian Kroon + * `BGM` - Bulgarian Socialist Lev - * `ETB` - Ethiopian Birr + * `BUK` - Burmese Kyat - * `EUR` - Euro + * `BIF` - Burundian Franc - * `XBA` - European Composite Unit + * `XPF` - CFP Franc - * `XEU` - European Currency Unit + * `KHR` - Cambodian Riel - * `XBB` - European Monetary Unit + * `CAD` - Canadian Dollar - * `XBC` - European Unit of Account (XBC) + * `CVE` - Cape Verdean Escudo - * `XBD` - European Unit of Account (XBD) + * `KYD` - Cayman Islands Dollar - * `FKP` - Falkland Islands Pound + * `XAF` - Central African CFA Franc - * `FJD` - Fijian Dollar + * `CLE` - Chilean Escudo - * `FIM` - Finnish Markka + * `CLP` - Chilean Peso - * `FRF` - French Franc + * `CLF` - Chilean Unit of Account (UF) - * `XFO` - French Gold Franc + * `CNX` - Chinese People’s Bank Dollar - * `XFU` - French UIC-Franc + * `CNY` - Chinese Yuan - * `GMD` - Gambian Dalasi + * `CNH` - Chinese Yuan (offshore) - * `GEK` - Georgian Kupon Larit + * `COP` - Colombian Peso - * `GEL` - Georgian Lari + * `COU` - Colombian Real Value Unit - * `DEM` - German Mark + * `KMF` - Comorian Franc - * `GHS` - Ghanaian Cedi + * `CDF` - Congolese Franc - * `GHC` - Ghanaian Cedi (1979–2007) + * `CRC` - Costa Rican Colón - * `GIP` - Gibraltar Pound + * `HRD` - Croatian Dinar - * `XAU` - Gold + * `HRK` - Croatian Kuna - * `GRD` - Greek Drachma + * `CUC` - Cuban Convertible Peso - * `GTQ` - Guatemalan Quetzal + * `CUP` - Cuban Peso - * `GWP` - Guinea-Bissau Peso + * `CYP` - Cypriot Pound - * `GNF` - Guinean Franc + * `CZK` - Czech Koruna - * `GNS` - Guinean Syli + * `CSK` - Czechoslovak Hard Koruna - * `GYD` - Guyanaese Dollar + * `DKK` - Danish Krone - * `HTG` - Haitian Gourde + * `DJF` - Djiboutian Franc - * `HNL` - Honduran Lempira + * `DOP` - Dominican Peso - * `HKD` - Hong Kong Dollar + * `NLG` - Dutch Guilder - * `HUF` - Hungarian Forint + * `XCD` - East Caribbean Dollar - * `IMP` - IMP + * `DDM` - East German Mark - * `ISK` - Icelandic Króna + * `ECS` - Ecuadorian Sucre - * `ISJ` - Icelandic Króna (1918–1981) + * `ECV` - Ecuadorian Unit of Constant Value - * `INR` - Indian Rupee + * `EGP` - Egyptian Pound - * `IDR` - Indonesian Rupiah + * `GQE` - Equatorial Guinean Ekwele - * `IRR` - Iranian Rial + * `ERN` - Eritrean Nakfa - * `IQD` - Iraqi Dinar + * `EEK` - Estonian Kroon - * `IEP` - Irish Pound + * `ETB` - Ethiopian Birr - * `ILS` - Israeli New Shekel + * `EUR` - Euro - * `ILP` - Israeli Pound + * `XBA` - European Composite Unit - * `ILR` - Israeli Shekel (1980–1985) + * `XEU` - European Currency Unit - * `ITL` - Italian Lira + * `XBB` - European Monetary Unit - * `JMD` - Jamaican Dollar + * `XBC` - European Unit of Account (XBC) - * `JPY` - Japanese Yen + * `XBD` - European Unit of Account (XBD) - * `JOD` - Jordanian Dinar + * `FKP` - Falkland Islands Pound - * `KZT` - Kazakhstani Tenge + * `FJD` - Fijian Dollar - * `KES` - Kenyan Shilling + * `FIM` - Finnish Markka - * `KWD` - Kuwaiti Dinar + * `FRF` - French Franc - * `KGS` - Kyrgystani Som + * `XFO` - French Gold Franc - * `LAK` - Laotian Kip + * `XFU` - French UIC-Franc - * `LVL` - Latvian Lats + * `GMD` - Gambian Dalasi - * `LVR` - Latvian Ruble + * `GEK` - Georgian Kupon Larit - * `LBP` - Lebanese Pound + * `GEL` - Georgian Lari - * `LSL` - Lesotho Loti + * `DEM` - German Mark - * `LRD` - Liberian Dollar + * `GHS` - Ghanaian Cedi - * `LYD` - Libyan Dinar + * `GHC` - Ghanaian Cedi (1979–2007) - * `LTL` - Lithuanian Litas + * `GIP` - Gibraltar Pound - * `LTT` - Lithuanian Talonas + * `XAU` - Gold - * `LUL` - Luxembourg Financial Franc + * `GRD` - Greek Drachma - * `LUC` - Luxembourgian Convertible Franc + * `GTQ` - Guatemalan Quetzal - * `LUF` - Luxembourgian Franc + * `GWP` - Guinea-Bissau Peso - * `MOP` - Macanese Pataca + * `GNF` - Guinean Franc - * `MKD` - Macedonian Denar + * `GNS` - Guinean Syli - * `MKN` - Macedonian Denar (1992–1993) + * `GYD` - Guyanaese Dollar - * `MGA` - Malagasy Ariary + * `HTG` - Haitian Gourde - * `MGF` - Malagasy Franc + * `HNL` - Honduran Lempira - * `MWK` - Malawian Kwacha + * `HKD` - Hong Kong Dollar - * `MYR` - Malaysian Ringgit + * `HUF` - Hungarian Forint - * `MVR` - Maldivian Rufiyaa + * `IMP` - IMP - * `MVP` - Maldivian Rupee (1947–1981) + * `ISK` - Icelandic Króna - * `MLF` - Malian Franc + * `ISJ` - Icelandic Króna (1918–1981) - * `MTL` - Maltese Lira + * `INR` - Indian Rupee - * `MTP` - Maltese Pound + * `IDR` - Indonesian Rupiah - * `MRU` - Mauritanian Ouguiya + * `IRR` - Iranian Rial - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `IQD` - Iraqi Dinar - * `MUR` - Mauritian Rupee + * `IEP` - Irish Pound - * `MXV` - Mexican Investment Unit + * `ILS` - Israeli New Shekel - * `MXN` - Mexican Peso + * `ILP` - Israeli Pound - * `MXP` - Mexican Silver Peso (1861–1992) + * `ILR` - Israeli Shekel (1980–1985) - * `MDC` - Moldovan Cupon + * `ITL` - Italian Lira - * `MDL` - Moldovan Leu + * `JMD` - Jamaican Dollar - * `MCF` - Monegasque Franc + * `JPY` - Japanese Yen - * `MNT` - Mongolian Tugrik + * `JOD` - Jordanian Dinar - * `MAD` - Moroccan Dirham + * `KZT` - Kazakhstani Tenge - * `MAF` - Moroccan Franc + * `KES` - Kenyan Shilling - * `MZE` - Mozambican Escudo + * `KWD` - Kuwaiti Dinar - * `MZN` - Mozambican Metical + * `KGS` - Kyrgystani Som - * `MZM` - Mozambican Metical (1980–2006) + * `LAK` - Laotian Kip - * `MMK` - Myanmar Kyat + * `LVL` - Latvian Lats - * `NAD` - Namibian Dollar + * `LVR` - Latvian Ruble - * `NPR` - Nepalese Rupee + * `LBP` - Lebanese Pound - * `ANG` - Netherlands Antillean Guilder + * `LSL` - Lesotho Loti - * `TWD` - New Taiwan Dollar + * `LRD` - Liberian Dollar - * `NZD` - New Zealand Dollar + * `LYD` - Libyan Dinar - * `NIO` - Nicaraguan Córdoba + * `LTL` - Lithuanian Litas - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `LTT` - Lithuanian Talonas - * `NGN` - Nigerian Naira + * `LUL` - Luxembourg Financial Franc - * `KPW` - North Korean Won + * `LUC` - Luxembourgian Convertible Franc - * `NOK` - Norwegian Krone + * `LUF` - Luxembourgian Franc - * `OMR` - Omani Rial + * `MOP` - Macanese Pataca - * `PKR` - Pakistani Rupee + * `MKD` - Macedonian Denar - * `XPD` - Palladium + * `MKN` - Macedonian Denar (1992–1993) - * `PAB` - Panamanian Balboa + * `MGA` - Malagasy Ariary - * `PGK` - Papua New Guinean Kina + * `MGF` - Malagasy Franc - * `PYG` - Paraguayan Guarani + * `MWK` - Malawian Kwacha - * `PEI` - Peruvian Inti + * `MYR` - Malaysian Ringgit - * `PEN` - Peruvian Sol + * `MVR` - Maldivian Rufiyaa - * `PES` - Peruvian Sol (1863–1965) + * `MVP` - Maldivian Rupee (1947–1981) - * `PHP` - Philippine Peso + * `MLF` - Malian Franc - * `XPT` - Platinum + * `MTL` - Maltese Lira - * `PLN` - Polish Zloty + * `MTP` - Maltese Pound - * `PLZ` - Polish Zloty (1950–1995) + * `MRU` - Mauritanian Ouguiya - * `PTE` - Portuguese Escudo + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `GWE` - Portuguese Guinea Escudo + * `MUR` - Mauritian Rupee - * `QAR` - Qatari Rial + * `MXV` - Mexican Investment Unit - * `XRE` - RINET Funds + * `MXN` - Mexican Peso - * `RHD` - Rhodesian Dollar + * `MXP` - Mexican Silver Peso (1861–1992) - * `RON` - Romanian Leu + * `MDC` - Moldovan Cupon - * `ROL` - Romanian Leu (1952–2006) + * `MDL` - Moldovan Leu - * `RUB` - Russian Ruble + * `MCF` - Monegasque Franc - * `RUR` - Russian Ruble (1991–1998) + * `MNT` - Mongolian Tugrik - * `RWF` - Rwandan Franc + * `MAD` - Moroccan Dirham - * `SVC` - Salvadoran Colón + * `MAF` - Moroccan Franc - * `WST` - Samoan Tala + * `MZE` - Mozambican Escudo - * `SAR` - Saudi Riyal + * `MZN` - Mozambican Metical - * `RSD` - Serbian Dinar + * `MZM` - Mozambican Metical (1980–2006) - * `CSD` - Serbian Dinar (2002–2006) + * `MMK` - Myanmar Kyat - * `SCR` - Seychellois Rupee + * `NAD` - Namibian Dollar - * `SLL` - Sierra Leonean Leone + * `NPR` - Nepalese Rupee - * `XAG` - Silver + * `ANG` - Netherlands Antillean Guilder - * `SGD` - Singapore Dollar + * `TWD` - New Taiwan Dollar - * `SKK` - Slovak Koruna + * `NZD` - New Zealand Dollar - * `SIT` - Slovenian Tolar + * `NIO` - Nicaraguan Córdoba - * `SBD` - Solomon Islands Dollar + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `SOS` - Somali Shilling + * `NGN` - Nigerian Naira - * `ZAR` - South African Rand + * `KPW` - North Korean Won - * `ZAL` - South African Rand (financial) + * `NOK` - Norwegian Krone - * `KRH` - South Korean Hwan (1953–1962) + * `OMR` - Omani Rial - * `KRW` - South Korean Won + * `PKR` - Pakistani Rupee - * `KRO` - South Korean Won (1945–1953) + * `XPD` - Palladium - * `SSP` - South Sudanese Pound + * `PAB` - Panamanian Balboa - * `SUR` - Soviet Rouble + * `PGK` - Papua New Guinean Kina - * `ESP` - Spanish Peseta + * `PYG` - Paraguayan Guarani - * `ESA` - Spanish Peseta (A account) + * `PEI` - Peruvian Inti - * `ESB` - Spanish Peseta (convertible account) + * `PEN` - Peruvian Sol - * `XDR` - Special Drawing Rights + * `PES` - Peruvian Sol (1863–1965) - * `LKR` - Sri Lankan Rupee + * `PHP` - Philippine Peso - * `SHP` - St. Helena Pound + * `XPT` - Platinum - * `XSU` - Sucre + * `PLN` - Polish Zloty - * `SDD` - Sudanese Dinar (1992–2007) + * `PLZ` - Polish Zloty (1950–1995) - * `SDG` - Sudanese Pound + * `PTE` - Portuguese Escudo - * `SDP` - Sudanese Pound (1957–1998) + * `GWE` - Portuguese Guinea Escudo - * `SRD` - Surinamese Dollar + * `QAR` - Qatari Rial - * `SRG` - Surinamese Guilder + * `XRE` - RINET Funds - * `SZL` - Swazi Lilangeni + * `RHD` - Rhodesian Dollar - * `SEK` - Swedish Krona + * `RON` - Romanian Leu - * `CHF` - Swiss Franc + * `ROL` - Romanian Leu (1952–2006) - * `SYP` - Syrian Pound + * `RUB` - Russian Ruble - * `STN` - São Tomé & Príncipe Dobra + * `RUR` - Russian Ruble (1991–1998) - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `RWF` - Rwandan Franc - * `TVD` - TVD + * `SVC` - Salvadoran Colón - * `TJR` - Tajikistani Ruble + * `WST` - Samoan Tala - * `TJS` - Tajikistani Somoni + * `SAR` - Saudi Riyal - * `TZS` - Tanzanian Shilling + * `RSD` - Serbian Dinar - * `XTS` - Testing Currency Code + * `CSD` - Serbian Dinar (2002–2006) - * `THB` - Thai Baht + * `SCR` - Seychellois Rupee - * `XXX` - The codes assigned for transactions where no currency is - involved + * `SLL` - Sierra Leonean Leone - * `TPE` - Timorese Escudo + * `XAG` - Silver - * `TOP` - Tongan Paʻanga + * `SGD` - Singapore Dollar - * `TTD` - Trinidad & Tobago Dollar + * `SKK` - Slovak Koruna - * `TND` - Tunisian Dinar + * `SIT` - Slovenian Tolar - * `TRY` - Turkish Lira + * `SBD` - Solomon Islands Dollar - * `TRL` - Turkish Lira (1922–2005) + * `SOS` - Somali Shilling - * `TMT` - Turkmenistani Manat + * `ZAR` - South African Rand - * `TMM` - Turkmenistani Manat (1993–2009) + * `ZAL` - South African Rand (financial) - * `USD` - US Dollar + * `KRH` - South Korean Hwan (1953–1962) - * `USN` - US Dollar (Next day) + * `KRW` - South Korean Won - * `USS` - US Dollar (Same day) + * `KRO` - South Korean Won (1945–1953) - * `UGX` - Ugandan Shilling + * `SSP` - South Sudanese Pound - * `UGS` - Ugandan Shilling (1966–1987) + * `SUR` - Soviet Rouble - * `UAH` - Ukrainian Hryvnia + * `ESP` - Spanish Peseta - * `UAK` - Ukrainian Karbovanets + * `ESA` - Spanish Peseta (A account) - * `AED` - United Arab Emirates Dirham + * `ESB` - Spanish Peseta (convertible account) - * `UYW` - Uruguayan Nominal Wage Index Unit + * `XDR` - Special Drawing Rights - * `UYU` - Uruguayan Peso + * `LKR` - Sri Lankan Rupee - * `UYP` - Uruguayan Peso (1975–1993) + * `SHP` - St. Helena Pound - * `UYI` - Uruguayan Peso (Indexed Units) + * `XSU` - Sucre - * `UZS` - Uzbekistani Som + * `SDD` - Sudanese Dinar (1992–2007) - * `VUV` - Vanuatu Vatu + * `SDG` - Sudanese Pound - * `VES` - Venezuelan Bolívar + * `SDP` - Sudanese Pound (1957–1998) - * `VEB` - Venezuelan Bolívar (1871–2008) + * `SRD` - Surinamese Dollar - * `VEF` - Venezuelan Bolívar (2008–2018) + * `SRG` - Surinamese Guilder - * `VND` - Vietnamese Dong + * `SZL` - Swazi Lilangeni - * `VNN` - Vietnamese Dong (1978–1985) + * `SEK` - Swedish Krona - * `CHE` - WIR Euro + * `CHF` - Swiss Franc - * `CHW` - WIR Franc + * `SYP` - Syrian Pound - * `XOF` - West African CFA Franc + * `STN` - São Tomé & Príncipe Dobra - * `YDD` - Yemeni Dinar + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `YER` - Yemeni Rial + * `TVD` - TVD - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `TJR` - Tajikistani Ruble - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `TJS` - Tajikistani Somoni - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `TZS` - Tanzanian Shilling - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `XTS` - Testing Currency Code - * `ZWN` - ZWN + * `THB` - Thai Baht - * `ZRN` - Zairean New Zaire (1993–1998) + * `XXX` - The codes assigned for transactions where no currency is + involved - * `ZRZ` - Zairean Zaire (1971–1993) + * `TPE` - Timorese Escudo - * `ZMW` - Zambian Kwacha + * `TOP` - Tongan Paʻanga - * `ZMK` - Zambian Kwacha (1968–2012) + * `TTD` - Trinidad & Tobago Dollar - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `TND` - Tunisian Dinar - * `ZWR` - Zimbabwean Dollar (2008) + * `TRY` - Turkish Lira - * `ZWL` - Zimbabwean Dollar (2009) - remote_created_at: - type: optional - docs: When the third party's credit note was created. - remote_updated_at: - type: optional - docs: When the third party's credit note was updated. - payments: - type: optional>> - docs: Array of `Payment` object IDs - applied_payments: - type: optional>> - docs: >- - A list of the Payment Applied to Lines common models related to a - given Invoice, Credit Note, or Journal Entry. - accounting_period: - type: optional - docs: The accounting period that the CreditNote was generated in. - applied_to_lines: - type: optional> - docs: >- - A list of the CreditNote Applied to Lines common models related to a - given Credit Note - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - CreditNoteApplyLineForCreditNoteInvoice: - discriminated: false - union: - - type: string - validation: - format: uuid - - Invoice - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteApplyLineForCreditNote: - docs: >- - # The CreditNoteApplyLine Object + * `TRL` - Turkish Lira (1922–2005) - ### Description + * `TMT` - Turkmenistani Manat - The `CreditNoteApplyLine` is attached to the CreditNote model. + * `TMM` - Turkmenistani Manat (1993–2009) + * `USD` - US Dollar - ### Usage Example + * `USN` - US Dollar (Next day) - Fetch from the `GET CreditNote` endpoint and view the invoice's applied to - lines. - properties: - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - invoice: optional - applied_date: - type: optional - docs: Date that the credit note is applied to the invoice. - applied_amount: - type: optional - docs: The amount of the Credit Note applied to the invoice. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - source: - openapi: openapi/openapi.yml - CreditNoteApplyLineForCreditNoteRequestInvoice: - discriminated: false - union: - - type: string - validation: - format: uuid - - Invoice - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteApplyLineForCreditNoteRequest: - docs: >- - # The CreditNoteApplyLine Object + * `USS` - US Dollar (Same day) - ### Description + * `UGX` - Ugandan Shilling - The `CreditNoteApplyLine` is attached to the CreditNote model. + * `UGS` - Ugandan Shilling (1966–1987) + * `UAH` - Ukrainian Hryvnia - ### Usage Example + * `UAK` - Ukrainian Karbovanets - Fetch from the `GET CreditNote` endpoint and view the invoice's applied to - lines. - properties: - remote_id: - type: optional - docs: The third-party API ID of the matching object. - invoice: optional - applied_date: - type: optional - docs: Date that the credit note is applied to the invoice. - applied_amount: - type: optional - docs: The amount of the Credit Note applied to the invoice. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - CreditNoteApplyLineForInvoiceCreditNote: - discriminated: false - union: - - type: string - validation: - format: uuid - - CreditNote - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteApplyLineForInvoice: - docs: >- - # The CreditNoteApplyLine Object + * `AED` - United Arab Emirates Dirham - ### Description + * `UYW` - Uruguayan Nominal Wage Index Unit - The `CreditNoteApplyLine` is attached to the CreditNote model. + * `UYU` - Uruguayan Peso + * `UYP` - Uruguayan Peso (1975–1993) - ### Usage Example + * `UYI` - Uruguayan Peso (Indexed Units) - Fetch from the `GET CreditNote` endpoint and view the invoice's applied to - lines. - properties: - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - credit_note: optional - applied_date: - type: optional - docs: Date that the credit note is applied to the invoice. - applied_amount: - type: optional - docs: The amount of the Credit Note applied to the invoice. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - source: - openapi: openapi/openapi.yml - CreditNoteLineItemItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - Item - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteLineItemCompany: - discriminated: false - docs: The company the credit note belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteLineItemContact: - discriminated: false - docs: The credit note's contact. - union: - - type: string - validation: - format: uuid - - Contact - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteLineItemProject: - discriminated: false + * `UZS` - Uzbekistani Som + + * `VUV` - Vanuatu Vatu + + * `VES` - Venezuelan Bolívar + + * `VEB` - Venezuelan Bolívar (1871–2008) + + * `VEF` - Venezuelan Bolívar (2008–2018) + + * `VND` - Vietnamese Dong + + * `VNN` - Vietnamese Dong (1978–1985) + + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) union: - - type: string - validation: - format: uuid - - Project + - TransactionCurrencyEnum + - string source: openapi: openapi/openapi.yml inline: true - CreditNoteLineItem: + CompanyInfo: docs: >- - # The CreditNoteLineItem Object + # The CompanyInfo Object ### Description - The `CreditNoteLineItem` object is used to represent a credit note's line - items. + The `CompanyInfo` object contains information about the company of the + linked account. If the company has multiple entities (also known as + subsidiaries), each entity may show up as a single `CompanyInfo` record. ### Usage Example - Fetch from the `GET CreditNote` endpoint and view the credit note's line - items. + Fetch from the `GET CompanyInfo` endpoint and view a company's + information. properties: id: type: optional @@ -14262,1746 +8726,2117 @@ types: type: optional docs: The datetime that this object was modified by Merge. access: read-only - item: optional name: type: optional - docs: The credit note line item's name. - description: - type: optional - docs: The description of the item that is owed. - quantity: - type: optional - docs: The credit note line item's quantity. - validation: - pattern: ^-?\d{0,24}(?:\.\d{0,8})?$ - memo: - type: optional - docs: The credit note line item's memo. - unit_price: - type: optional - docs: The credit note line item's unit price. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - tax_rate: - type: optional - docs: The tax rate that applies to this line item. - validation: - format: uuid - total_line_amount: + docs: The company's name. + legal_name: type: optional - docs: The credit note line item's total. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - tracking_category: + docs: The company's legal name. + tax_number: type: optional - docs: The credit note line item's associated tracking category. + docs: The company's tax number. + fiscal_year_end_month: + type: optional + docs: The company's fiscal year end month. validation: - format: uuid - availability: deprecated - tracking_categories: - type: optional>> - docs: The credit note line item's associated tracking categories. - account: - type: optional - docs: The credit note line item's account. + min: 1 + max: 12 + fiscal_year_end_day: + type: optional + docs: The company's fiscal year end day. validation: - format: uuid - company: - type: optional - docs: The company the credit note belongs to. - contact: - type: optional - docs: The credit note's contact. - project: optional - remote_was_deleted: - type: optional + min: 1 + max: 31 + currency: + type: optional docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - source: - openapi: openapi/openapi.yml - CreditNoteLineItemRequestItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - Item - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteLineItemRequestCompany: - discriminated: false - docs: The company the credit note belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteLineItemRequestContact: - discriminated: false - docs: The credit note's contact. - union: - - type: string - validation: - format: uuid - - Contact - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteLineItemRequestProject: - discriminated: false - union: - - type: string - validation: - format: uuid - - Contact - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteLineItemRequest: - docs: >- - # The CreditNoteLineItem Object + The currency set in the company's accounting platform. - ### Description - The `CreditNoteLineItem` object is used to represent a credit note's line - items. + * `XUA` - ADB Unit of Account + * `AFN` - Afghan Afghani - ### Usage Example + * `AFA` - Afghan Afghani (1927–2002) - Fetch from the `GET CreditNote` endpoint and view the credit note's line - items. - properties: - remote_id: - type: optional - docs: The third-party API ID of the matching object. - item: optional - name: - type: optional - docs: The credit note line item's name. - description: - type: optional - docs: The description of the item that is owed. - quantity: - type: optional - docs: The credit note line item's quantity. - validation: - pattern: ^-?\d{0,24}(?:\.\d{0,8})?$ - memo: - type: optional - docs: The credit note line item's memo. - unit_price: - type: optional - docs: The credit note line item's unit price. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - tax_rate: - type: optional - docs: The tax rate that applies to this line item. - validation: - format: uuid - total_line_amount: - type: optional - docs: The credit note line item's total. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - tracking_category: - type: optional - docs: The credit note line item's associated tracking category. - validation: - format: uuid - availability: deprecated - tracking_categories: - type: optional>> - docs: The credit note line item's associated tracking categories. - account: - type: optional - docs: The credit note line item's account. - validation: - format: uuid - company: - type: optional - docs: The company the credit note belongs to. - contact: - type: optional - docs: The credit note's contact. - project: optional - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - CreditNoteRequestStatus: - discriminated: false - docs: |- - The credit note's status. + * `ALL` - Albanian Lek - * `SUBMITTED` - SUBMITTED - * `AUTHORIZED` - AUTHORIZED - * `PAID` - PAID - union: - - CreditNoteStatusEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteRequestContact: - discriminated: false - docs: The credit note's contact. - union: - - type: string - validation: - format: uuid - - Contact - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteRequestCompany: - discriminated: false - docs: The company the credit note belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteRequestLineItemsItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - CreditNoteLineItemRequest - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteRequestTrackingCategoriesItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - TrackingCategory - source: - openapi: openapi/openapi.yml - inline: true - CreditNoteRequestCurrency: - discriminated: false - docs: >- - The credit note's currency. + * `ALK` - Albanian Lek (1946–1965) + * `DZD` - Algerian Dinar - * `XUA` - ADB Unit of Account + * `ADP` - Andorran Peseta - * `AFN` - Afghan Afghani + * `AOA` - Angolan Kwanza - * `AFA` - Afghan Afghani (1927–2002) + * `AOK` - Angolan Kwanza (1977–1991) - * `ALL` - Albanian Lek + * `AON` - Angolan New Kwanza (1990–2000) - * `ALK` - Albanian Lek (1946–1965) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `DZD` - Algerian Dinar + * `ARA` - Argentine Austral - * `ADP` - Andorran Peseta + * `ARS` - Argentine Peso - * `AOA` - Angolan Kwanza + * `ARM` - Argentine Peso (1881–1970) - * `AOK` - Angolan Kwanza (1977–1991) + * `ARP` - Argentine Peso (1983–1985) - * `AON` - Angolan New Kwanza (1990–2000) + * `ARL` - Argentine Peso Ley (1970–1983) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `AMD` - Armenian Dram - * `ARA` - Argentine Austral + * `AWG` - Aruban Florin - * `ARS` - Argentine Peso + * `AUD` - Australian Dollar - * `ARM` - Argentine Peso (1881–1970) + * `ATS` - Austrian Schilling - * `ARP` - Argentine Peso (1983–1985) + * `AZN` - Azerbaijani Manat - * `ARL` - Argentine Peso Ley (1970–1983) + * `AZM` - Azerbaijani Manat (1993–2006) - * `AMD` - Armenian Dram + * `BSD` - Bahamian Dollar - * `AWG` - Aruban Florin + * `BHD` - Bahraini Dinar - * `AUD` - Australian Dollar + * `BDT` - Bangladeshi Taka - * `ATS` - Austrian Schilling + * `BBD` - Barbadian Dollar - * `AZN` - Azerbaijani Manat + * `BYN` - Belarusian Ruble - * `AZM` - Azerbaijani Manat (1993–2006) + * `BYB` - Belarusian Ruble (1994–1999) - * `BSD` - Bahamian Dollar + * `BYR` - Belarusian Ruble (2000–2016) - * `BHD` - Bahraini Dinar + * `BEF` - Belgian Franc + + * `BEC` - Belgian Franc (convertible) + + * `BEL` - Belgian Franc (financial) + + * `BZD` - Belize Dollar + + * `BMD` - Bermudan Dollar + + * `BTN` - Bhutanese Ngultrum + + * `BOB` - Bolivian Boliviano + + * `BOL` - Bolivian Boliviano (1863–1963) + + * `BOV` - Bolivian Mvdol + + * `BOP` - Bolivian Peso + + * `BAM` - Bosnia-Herzegovina Convertible Mark + + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + + * `BWP` - Botswanan Pula - * `BDT` - Bangladeshi Taka + * `BRC` - Brazilian Cruzado (1986–1989) - * `BBD` - Barbadian Dollar + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BYN` - Belarusian Ruble + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BYB` - Belarusian Ruble (1994–1999) + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BYR` - Belarusian Ruble (2000–2016) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BEF` - Belgian Franc + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BEC` - Belgian Franc (convertible) + * `BRL` - Brazilian Real - * `BEL` - Belgian Franc (financial) + * `GBP` - British Pound - * `BZD` - Belize Dollar + * `BND` - Brunei Dollar - * `BMD` - Bermudan Dollar + * `BGL` - Bulgarian Hard Lev - * `BTN` - Bhutanese Ngultrum + * `BGN` - Bulgarian Lev - * `BOB` - Bolivian Boliviano + * `BGO` - Bulgarian Lev (1879–1952) - * `BOL` - Bolivian Boliviano (1863–1963) + * `BGM` - Bulgarian Socialist Lev - * `BOV` - Bolivian Mvdol + * `BUK` - Burmese Kyat - * `BOP` - Bolivian Peso + * `BIF` - Burundian Franc - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `XPF` - CFP Franc - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `KHR` - Cambodian Riel - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `CAD` - Canadian Dollar - * `BWP` - Botswanan Pula + * `CVE` - Cape Verdean Escudo - * `BRC` - Brazilian Cruzado (1986–1989) + * `KYD` - Cayman Islands Dollar - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `XAF` - Central African CFA Franc - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `CLE` - Chilean Escudo - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `CLP` - Chilean Peso - * `BRN` - Brazilian New Cruzado (1989–1990) + * `CLF` - Chilean Unit of Account (UF) - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `CNX` - Chinese People’s Bank Dollar - * `BRL` - Brazilian Real + * `CNY` - Chinese Yuan - * `GBP` - British Pound + * `CNH` - Chinese Yuan (offshore) - * `BND` - Brunei Dollar + * `COP` - Colombian Peso - * `BGL` - Bulgarian Hard Lev + * `COU` - Colombian Real Value Unit - * `BGN` - Bulgarian Lev + * `KMF` - Comorian Franc - * `BGO` - Bulgarian Lev (1879–1952) + * `CDF` - Congolese Franc - * `BGM` - Bulgarian Socialist Lev + * `CRC` - Costa Rican Colón - * `BUK` - Burmese Kyat + * `HRD` - Croatian Dinar - * `BIF` - Burundian Franc + * `HRK` - Croatian Kuna - * `XPF` - CFP Franc + * `CUC` - Cuban Convertible Peso - * `KHR` - Cambodian Riel + * `CUP` - Cuban Peso - * `CAD` - Canadian Dollar + * `CYP` - Cypriot Pound - * `CVE` - Cape Verdean Escudo + * `CZK` - Czech Koruna - * `KYD` - Cayman Islands Dollar + * `CSK` - Czechoslovak Hard Koruna - * `XAF` - Central African CFA Franc + * `DKK` - Danish Krone - * `CLE` - Chilean Escudo + * `DJF` - Djiboutian Franc - * `CLP` - Chilean Peso + * `DOP` - Dominican Peso - * `CLF` - Chilean Unit of Account (UF) + * `NLG` - Dutch Guilder - * `CNX` - Chinese People’s Bank Dollar + * `XCD` - East Caribbean Dollar - * `CNY` - Chinese Yuan + * `DDM` - East German Mark - * `CNH` - Chinese Yuan (offshore) + * `ECS` - Ecuadorian Sucre - * `COP` - Colombian Peso + * `ECV` - Ecuadorian Unit of Constant Value - * `COU` - Colombian Real Value Unit + * `EGP` - Egyptian Pound - * `KMF` - Comorian Franc + * `GQE` - Equatorial Guinean Ekwele - * `CDF` - Congolese Franc + * `ERN` - Eritrean Nakfa - * `CRC` - Costa Rican Colón + * `EEK` - Estonian Kroon - * `HRD` - Croatian Dinar + * `ETB` - Ethiopian Birr - * `HRK` - Croatian Kuna + * `EUR` - Euro - * `CUC` - Cuban Convertible Peso + * `XBA` - European Composite Unit - * `CUP` - Cuban Peso + * `XEU` - European Currency Unit - * `CYP` - Cypriot Pound + * `XBB` - European Monetary Unit - * `CZK` - Czech Koruna + * `XBC` - European Unit of Account (XBC) - * `CSK` - Czechoslovak Hard Koruna + * `XBD` - European Unit of Account (XBD) - * `DKK` - Danish Krone + * `FKP` - Falkland Islands Pound - * `DJF` - Djiboutian Franc + * `FJD` - Fijian Dollar - * `DOP` - Dominican Peso + * `FIM` - Finnish Markka - * `NLG` - Dutch Guilder + * `FRF` - French Franc - * `XCD` - East Caribbean Dollar + * `XFO` - French Gold Franc - * `DDM` - East German Mark + * `XFU` - French UIC-Franc - * `ECS` - Ecuadorian Sucre + * `GMD` - Gambian Dalasi - * `ECV` - Ecuadorian Unit of Constant Value + * `GEK` - Georgian Kupon Larit - * `EGP` - Egyptian Pound + * `GEL` - Georgian Lari - * `GQE` - Equatorial Guinean Ekwele + * `DEM` - German Mark - * `ERN` - Eritrean Nakfa + * `GHS` - Ghanaian Cedi - * `EEK` - Estonian Kroon + * `GHC` - Ghanaian Cedi (1979–2007) - * `ETB` - Ethiopian Birr + * `GIP` - Gibraltar Pound - * `EUR` - Euro + * `XAU` - Gold - * `XBA` - European Composite Unit + * `GRD` - Greek Drachma - * `XEU` - European Currency Unit + * `GTQ` - Guatemalan Quetzal - * `XBB` - European Monetary Unit + * `GWP` - Guinea-Bissau Peso - * `XBC` - European Unit of Account (XBC) + * `GNF` - Guinean Franc - * `XBD` - European Unit of Account (XBD) + * `GNS` - Guinean Syli - * `FKP` - Falkland Islands Pound + * `GYD` - Guyanaese Dollar - * `FJD` - Fijian Dollar + * `HTG` - Haitian Gourde - * `FIM` - Finnish Markka + * `HNL` - Honduran Lempira - * `FRF` - French Franc + * `HKD` - Hong Kong Dollar - * `XFO` - French Gold Franc + * `HUF` - Hungarian Forint - * `XFU` - French UIC-Franc + * `IMP` - IMP - * `GMD` - Gambian Dalasi + * `ISK` - Icelandic Króna - * `GEK` - Georgian Kupon Larit + * `ISJ` - Icelandic Króna (1918–1981) - * `GEL` - Georgian Lari + * `INR` - Indian Rupee - * `DEM` - German Mark + * `IDR` - Indonesian Rupiah - * `GHS` - Ghanaian Cedi + * `IRR` - Iranian Rial - * `GHC` - Ghanaian Cedi (1979–2007) + * `IQD` - Iraqi Dinar - * `GIP` - Gibraltar Pound + * `IEP` - Irish Pound - * `XAU` - Gold + * `ILS` - Israeli New Shekel - * `GRD` - Greek Drachma + * `ILP` - Israeli Pound - * `GTQ` - Guatemalan Quetzal + * `ILR` - Israeli Shekel (1980–1985) - * `GWP` - Guinea-Bissau Peso + * `ITL` - Italian Lira - * `GNF` - Guinean Franc + * `JMD` - Jamaican Dollar - * `GNS` - Guinean Syli + * `JPY` - Japanese Yen - * `GYD` - Guyanaese Dollar + * `JOD` - Jordanian Dinar - * `HTG` - Haitian Gourde + * `KZT` - Kazakhstani Tenge - * `HNL` - Honduran Lempira + * `KES` - Kenyan Shilling - * `HKD` - Hong Kong Dollar + * `KWD` - Kuwaiti Dinar - * `HUF` - Hungarian Forint + * `KGS` - Kyrgystani Som - * `IMP` - IMP + * `LAK` - Laotian Kip - * `ISK` - Icelandic Króna + * `LVL` - Latvian Lats - * `ISJ` - Icelandic Króna (1918–1981) + * `LVR` - Latvian Ruble - * `INR` - Indian Rupee + * `LBP` - Lebanese Pound - * `IDR` - Indonesian Rupiah + * `LSL` - Lesotho Loti - * `IRR` - Iranian Rial + * `LRD` - Liberian Dollar - * `IQD` - Iraqi Dinar + * `LYD` - Libyan Dinar - * `IEP` - Irish Pound + * `LTL` - Lithuanian Litas - * `ILS` - Israeli New Shekel + * `LTT` - Lithuanian Talonas - * `ILP` - Israeli Pound + * `LUL` - Luxembourg Financial Franc - * `ILR` - Israeli Shekel (1980–1985) + * `LUC` - Luxembourgian Convertible Franc - * `ITL` - Italian Lira + * `LUF` - Luxembourgian Franc - * `JMD` - Jamaican Dollar + * `MOP` - Macanese Pataca - * `JPY` - Japanese Yen + * `MKD` - Macedonian Denar - * `JOD` - Jordanian Dinar + * `MKN` - Macedonian Denar (1992–1993) - * `KZT` - Kazakhstani Tenge + * `MGA` - Malagasy Ariary - * `KES` - Kenyan Shilling + * `MGF` - Malagasy Franc - * `KWD` - Kuwaiti Dinar + * `MWK` - Malawian Kwacha - * `KGS` - Kyrgystani Som + * `MYR` - Malaysian Ringgit - * `LAK` - Laotian Kip + * `MVR` - Maldivian Rufiyaa - * `LVL` - Latvian Lats + * `MVP` - Maldivian Rupee (1947–1981) - * `LVR` - Latvian Ruble + * `MLF` - Malian Franc - * `LBP` - Lebanese Pound + * `MTL` - Maltese Lira - * `LSL` - Lesotho Loti + * `MTP` - Maltese Pound - * `LRD` - Liberian Dollar + * `MRU` - Mauritanian Ouguiya - * `LYD` - Libyan Dinar + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `LTL` - Lithuanian Litas + * `MUR` - Mauritian Rupee - * `LTT` - Lithuanian Talonas + * `MXV` - Mexican Investment Unit - * `LUL` - Luxembourg Financial Franc + * `MXN` - Mexican Peso - * `LUC` - Luxembourgian Convertible Franc + * `MXP` - Mexican Silver Peso (1861–1992) - * `LUF` - Luxembourgian Franc + * `MDC` - Moldovan Cupon - * `MOP` - Macanese Pataca + * `MDL` - Moldovan Leu - * `MKD` - Macedonian Denar + * `MCF` - Monegasque Franc - * `MKN` - Macedonian Denar (1992–1993) + * `MNT` - Mongolian Tugrik - * `MGA` - Malagasy Ariary + * `MAD` - Moroccan Dirham - * `MGF` - Malagasy Franc + * `MAF` - Moroccan Franc - * `MWK` - Malawian Kwacha + * `MZE` - Mozambican Escudo - * `MYR` - Malaysian Ringgit + * `MZN` - Mozambican Metical - * `MVR` - Maldivian Rufiyaa + * `MZM` - Mozambican Metical (1980–2006) - * `MVP` - Maldivian Rupee (1947–1981) + * `MMK` - Myanmar Kyat - * `MLF` - Malian Franc + * `NAD` - Namibian Dollar - * `MTL` - Maltese Lira + * `NPR` - Nepalese Rupee - * `MTP` - Maltese Pound + * `ANG` - Netherlands Antillean Guilder - * `MRU` - Mauritanian Ouguiya + * `TWD` - New Taiwan Dollar - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `NZD` - New Zealand Dollar - * `MUR` - Mauritian Rupee + * `NIO` - Nicaraguan Córdoba - * `MXV` - Mexican Investment Unit + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `MXN` - Mexican Peso + * `NGN` - Nigerian Naira - * `MXP` - Mexican Silver Peso (1861–1992) + * `KPW` - North Korean Won - * `MDC` - Moldovan Cupon + * `NOK` - Norwegian Krone - * `MDL` - Moldovan Leu + * `OMR` - Omani Rial - * `MCF` - Monegasque Franc + * `PKR` - Pakistani Rupee - * `MNT` - Mongolian Tugrik + * `XPD` - Palladium - * `MAD` - Moroccan Dirham + * `PAB` - Panamanian Balboa - * `MAF` - Moroccan Franc + * `PGK` - Papua New Guinean Kina - * `MZE` - Mozambican Escudo + * `PYG` - Paraguayan Guarani - * `MZN` - Mozambican Metical + * `PEI` - Peruvian Inti - * `MZM` - Mozambican Metical (1980–2006) + * `PEN` - Peruvian Sol - * `MMK` - Myanmar Kyat + * `PES` - Peruvian Sol (1863–1965) - * `NAD` - Namibian Dollar + * `PHP` - Philippine Peso - * `NPR` - Nepalese Rupee + * `XPT` - Platinum - * `ANG` - Netherlands Antillean Guilder + * `PLN` - Polish Zloty - * `TWD` - New Taiwan Dollar + * `PLZ` - Polish Zloty (1950–1995) - * `NZD` - New Zealand Dollar + * `PTE` - Portuguese Escudo - * `NIO` - Nicaraguan Córdoba + * `GWE` - Portuguese Guinea Escudo - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `QAR` - Qatari Rial - * `NGN` - Nigerian Naira + * `XRE` - RINET Funds - * `KPW` - North Korean Won + * `RHD` - Rhodesian Dollar - * `NOK` - Norwegian Krone + * `RON` - Romanian Leu - * `OMR` - Omani Rial + * `ROL` - Romanian Leu (1952–2006) - * `PKR` - Pakistani Rupee + * `RUB` - Russian Ruble - * `XPD` - Palladium + * `RUR` - Russian Ruble (1991–1998) - * `PAB` - Panamanian Balboa + * `RWF` - Rwandan Franc - * `PGK` - Papua New Guinean Kina + * `SVC` - Salvadoran Colón - * `PYG` - Paraguayan Guarani + * `WST` - Samoan Tala - * `PEI` - Peruvian Inti + * `SAR` - Saudi Riyal - * `PEN` - Peruvian Sol + * `RSD` - Serbian Dinar - * `PES` - Peruvian Sol (1863–1965) + * `CSD` - Serbian Dinar (2002–2006) - * `PHP` - Philippine Peso + * `SCR` - Seychellois Rupee - * `XPT` - Platinum + * `SLL` - Sierra Leonean Leone - * `PLN` - Polish Zloty + * `XAG` - Silver - * `PLZ` - Polish Zloty (1950–1995) + * `SGD` - Singapore Dollar - * `PTE` - Portuguese Escudo + * `SKK` - Slovak Koruna - * `GWE` - Portuguese Guinea Escudo + * `SIT` - Slovenian Tolar - * `QAR` - Qatari Rial + * `SBD` - Solomon Islands Dollar - * `XRE` - RINET Funds + * `SOS` - Somali Shilling - * `RHD` - Rhodesian Dollar + * `ZAR` - South African Rand - * `RON` - Romanian Leu + * `ZAL` - South African Rand (financial) - * `ROL` - Romanian Leu (1952–2006) + * `KRH` - South Korean Hwan (1953–1962) - * `RUB` - Russian Ruble + * `KRW` - South Korean Won - * `RUR` - Russian Ruble (1991–1998) + * `KRO` - South Korean Won (1945–1953) - * `RWF` - Rwandan Franc + * `SSP` - South Sudanese Pound - * `SVC` - Salvadoran Colón + * `SUR` - Soviet Rouble - * `WST` - Samoan Tala + * `ESP` - Spanish Peseta - * `SAR` - Saudi Riyal + * `ESA` - Spanish Peseta (A account) - * `RSD` - Serbian Dinar + * `ESB` - Spanish Peseta (convertible account) - * `CSD` - Serbian Dinar (2002–2006) + * `XDR` - Special Drawing Rights - * `SCR` - Seychellois Rupee + * `LKR` - Sri Lankan Rupee - * `SLL` - Sierra Leonean Leone + * `SHP` - St. Helena Pound - * `XAG` - Silver + * `XSU` - Sucre - * `SGD` - Singapore Dollar + * `SDD` - Sudanese Dinar (1992–2007) - * `SKK` - Slovak Koruna + * `SDG` - Sudanese Pound - * `SIT` - Slovenian Tolar + * `SDP` - Sudanese Pound (1957–1998) - * `SBD` - Solomon Islands Dollar + * `SRD` - Surinamese Dollar - * `SOS` - Somali Shilling + * `SRG` - Surinamese Guilder - * `ZAR` - South African Rand + * `SZL` - Swazi Lilangeni - * `ZAL` - South African Rand (financial) + * `SEK` - Swedish Krona - * `KRH` - South Korean Hwan (1953–1962) + * `CHF` - Swiss Franc - * `KRW` - South Korean Won + * `SYP` - Syrian Pound - * `KRO` - South Korean Won (1945–1953) + * `STN` - São Tomé & Príncipe Dobra - * `SSP` - South Sudanese Pound + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `SUR` - Soviet Rouble + * `TVD` - TVD - * `ESP` - Spanish Peseta + * `TJR` - Tajikistani Ruble - * `ESA` - Spanish Peseta (A account) + * `TJS` - Tajikistani Somoni - * `ESB` - Spanish Peseta (convertible account) + * `TZS` - Tanzanian Shilling - * `XDR` - Special Drawing Rights + * `XTS` - Testing Currency Code - * `LKR` - Sri Lankan Rupee + * `THB` - Thai Baht - * `SHP` - St. Helena Pound + * `XXX` - The codes assigned for transactions where no currency is + involved - * `XSU` - Sucre + * `TPE` - Timorese Escudo - * `SDD` - Sudanese Dinar (1992–2007) + * `TOP` - Tongan Paʻanga - * `SDG` - Sudanese Pound + * `TTD` - Trinidad & Tobago Dollar - * `SDP` - Sudanese Pound (1957–1998) + * `TND` - Tunisian Dinar - * `SRD` - Surinamese Dollar + * `TRY` - Turkish Lira - * `SRG` - Surinamese Guilder + * `TRL` - Turkish Lira (1922–2005) - * `SZL` - Swazi Lilangeni + * `TMT` - Turkmenistani Manat - * `SEK` - Swedish Krona + * `TMM` - Turkmenistani Manat (1993–2009) - * `CHF` - Swiss Franc + * `USD` - US Dollar - * `SYP` - Syrian Pound + * `USN` - US Dollar (Next day) - * `STN` - São Tomé & Príncipe Dobra + * `USS` - US Dollar (Same day) - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `UGX` - Ugandan Shilling - * `TVD` - TVD + * `UGS` - Ugandan Shilling (1966–1987) - * `TJR` - Tajikistani Ruble + * `UAH` - Ukrainian Hryvnia - * `TJS` - Tajikistani Somoni + * `UAK` - Ukrainian Karbovanets - * `TZS` - Tanzanian Shilling + * `AED` - United Arab Emirates Dirham - * `XTS` - Testing Currency Code + * `UYW` - Uruguayan Nominal Wage Index Unit - * `THB` - Thai Baht + * `UYU` - Uruguayan Peso - * `XXX` - The codes assigned for transactions where no currency is - involved + * `UYP` - Uruguayan Peso (1975–1993) - * `TPE` - Timorese Escudo + * `UYI` - Uruguayan Peso (Indexed Units) - * `TOP` - Tongan Paʻanga + * `UZS` - Uzbekistani Som - * `TTD` - Trinidad & Tobago Dollar + * `VUV` - Vanuatu Vatu - * `TND` - Tunisian Dinar + * `VES` - Venezuelan Bolívar - * `TRY` - Turkish Lira + * `VEB` - Venezuelan Bolívar (1871–2008) - * `TRL` - Turkish Lira (1922–2005) + * `VEF` - Venezuelan Bolívar (2008–2018) - * `TMT` - Turkmenistani Manat + * `VND` - Vietnamese Dong - * `TMM` - Turkmenistani Manat (1993–2009) + * `VNN` - Vietnamese Dong (1978–1985) - * `USD` - US Dollar + * `CHE` - WIR Euro - * `USN` - US Dollar (Next day) + * `CHW` - WIR Franc - * `USS` - US Dollar (Same day) + * `XOF` - West African CFA Franc - * `UGX` - Ugandan Shilling + * `YDD` - Yemeni Dinar - * `UGS` - Ugandan Shilling (1966–1987) + * `YER` - Yemeni Rial - * `UAH` - Ukrainian Hryvnia + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `UAK` - Ukrainian Karbovanets + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `AED` - United Arab Emirates Dirham + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `UYW` - Uruguayan Nominal Wage Index Unit + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `UYU` - Uruguayan Peso + * `ZWN` - ZWN - * `UYP` - Uruguayan Peso (1975–1993) + * `ZRN` - Zairean New Zaire (1993–1998) - * `UYI` - Uruguayan Peso (Indexed Units) + * `ZRZ` - Zairean Zaire (1971–1993) - * `UZS` - Uzbekistani Som + * `ZMW` - Zambian Kwacha - * `VUV` - Vanuatu Vatu + * `ZMK` - Zambian Kwacha (1968–2012) - * `VES` - Venezuelan Bolívar + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `VEB` - Venezuelan Bolívar (1871–2008) + * `ZWR` - Zimbabwean Dollar (2008) - * `VEF` - Venezuelan Bolívar (2008–2018) + * `ZWL` - Zimbabwean Dollar (2009) + remote_created_at: + type: optional + docs: When the third party's company was created. + urls: + type: optional>> + docs: The company's urls. + addresses: optional> + phone_numbers: optional> + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + ComponentTypeEnum: + enum: + - SALES + - PURCHASE + docs: |- + * `SALES` - SALES + * `PURCHASE` - PURCHASE + source: + openapi: openapi/openapi.yml + ContactStatus: + discriminated: false + docs: |- + The contact's status - * `VND` - Vietnamese Dong + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + union: + - Status7D1Enum + - string + source: + openapi: openapi/openapi.yml + inline: true + ContactAddressesItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - Address + source: + openapi: openapi/openapi.yml + inline: true + Contact: + docs: >- + # The Contact Object - * `VNN` - Vietnamese Dong (1978–1985) + ### Description - * `CHE` - WIR Euro + A `Contact` is an individual or business entity to which products and + services are sold to or purchased from. The `Contact` model contains both + Customers, in which products and services are sold to, and Vendors (or + Suppliers), in which products and services are purchased from. - * `CHW` - WIR Franc + * A `Contact` is a Vendor/Supplier if the `is_supplier` property is true. - * `XOF` - West African CFA Franc + * A `Contact` is a customer if the `is_customer` property is true. - * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial + ### Usage Example - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + Fetch from the `LIST Contacts` endpoint and view a company's contacts. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + name: + type: optional + docs: The contact's name. + is_supplier: + type: optional + docs: Whether the contact is a supplier. + is_customer: + type: optional + docs: Whether the contact is a customer. + email_address: + type: optional + docs: The contact's email address. + tax_number: + type: optional + docs: The contact's tax number. + status: + type: optional + docs: |- + The contact's status - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + currency: + type: optional + docs: The currency the contact's transactions are in. + remote_updated_at: + type: optional + docs: When the third party's contact was updated. + company: + type: optional + docs: The company the contact belongs to. + validation: + format: uuid + addresses: + type: optional>> + docs: '`Address` object IDs for the given `Contacts` object.' + phone_numbers: + type: optional> + docs: '`AccountingPhoneNumber` object for the given `Contacts` object.' + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> + access: read-only + remote_fields: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + ContactRequestStatus: + discriminated: false + docs: |- + The contact's status - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + union: + - Status7D1Enum + - string + source: + openapi: openapi/openapi.yml + inline: true + ContactRequestAddressesItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - Address + source: + openapi: openapi/openapi.yml + inline: true + ContactRequest: + docs: >- + # The Contact Object - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + ### Description - * `ZWN` - ZWN + A `Contact` is an individual or business entity to which products and + services are sold to or purchased from. The `Contact` model contains both + Customers, in which products and services are sold to, and Vendors (or + Suppliers), in which products and services are purchased from. - * `ZRN` - Zairean New Zaire (1993–1998) + * A `Contact` is a Vendor/Supplier if the `is_supplier` property is true. - * `ZRZ` - Zairean Zaire (1971–1993) + * A `Contact` is a customer if the `is_customer` property is true. - * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) + ### Usage Example - * `ZWD` - Zimbabwean Dollar (1980–2008) + Fetch from the `LIST Contacts` endpoint and view a company's contacts. + properties: + name: + type: optional + docs: The contact's name. + is_supplier: + type: optional + docs: Whether the contact is a supplier. + is_customer: + type: optional + docs: Whether the contact is a customer. + email_address: + type: optional + docs: The contact's email address. + tax_number: + type: optional + docs: The contact's tax number. + status: + type: optional + docs: |- + The contact's status - * `ZWR` - Zimbabwean Dollar (2008) + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + currency: + type: optional + docs: The currency the contact's transactions are in. + company: + type: optional + docs: The company the contact belongs to. + validation: + format: uuid + addresses: + type: optional>> + docs: '`Address` object IDs for the given `Contacts` object.' + phone_numbers: + type: optional> + docs: '`AccountingPhoneNumber` object for the given `Contacts` object.' + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + remote_fields: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + ContactResponse: + properties: + model: Contact + warnings: list + errors: list + logs: optional> + source: + openapi: openapi/openapi.yml + CountryEnum: + enum: + - 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 + - DE + - 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 + - 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 + - KP + - MK + - MP + - 'NO' + - 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 + - KR + - SS + - ES + - LK + - SD + - SR + - SJ + - SE + - CH + - SY + - TW + - TJ + - TZ + - TH + - TL + - TG + - TK + - TO + - TT + - TN + - TR + - TM + - TC + - TV + - UG + - UA + - AE + - GB + - UM + - US + - UY + - UZ + - VU + - VE + - VN + - VG + - VI + - WF + - EH + - YE + - ZM + - ZW + docs: |- + * `AF` - Afghanistan + * `AX` - Åland Islands + * `AL` - Albania + * `DZ` - Algeria + * `AS` - American Samoa + * `AD` - Andorra + * `AO` - Angola + * `AI` - Anguilla + * `AQ` - Antarctica + * `AG` - Antigua and Barbuda + * `AR` - Argentina + * `AM` - Armenia + * `AW` - Aruba + * `AU` - Australia + * `AT` - Austria + * `AZ` - Azerbaijan + * `BS` - Bahamas + * `BH` - Bahrain + * `BD` - Bangladesh + * `BB` - Barbados + * `BY` - Belarus + * `BE` - Belgium + * `BZ` - Belize + * `BJ` - Benin + * `BM` - Bermuda + * `BT` - Bhutan + * `BO` - Bolivia + * `BQ` - Bonaire, Sint Eustatius and Saba + * `BA` - Bosnia and Herzegovina + * `BW` - Botswana + * `BV` - Bouvet Island + * `BR` - Brazil + * `IO` - British Indian Ocean Territory + * `BN` - Brunei + * `BG` - Bulgaria + * `BF` - Burkina Faso + * `BI` - Burundi + * `CV` - Cabo Verde + * `KH` - Cambodia + * `CM` - Cameroon + * `CA` - Canada + * `KY` - Cayman Islands + * `CF` - Central African Republic + * `TD` - Chad + * `CL` - Chile + * `CN` - China + * `CX` - Christmas Island + * `CC` - Cocos (Keeling) Islands + * `CO` - Colombia + * `KM` - Comoros + * `CG` - Congo + * `CD` - Congo (the Democratic Republic of the) + * `CK` - Cook Islands + * `CR` - Costa Rica + * `CI` - Côte d'Ivoire + * `HR` - Croatia + * `CU` - Cuba + * `CW` - Curaçao + * `CY` - Cyprus + * `CZ` - Czechia + * `DK` - Denmark + * `DJ` - Djibouti + * `DM` - Dominica + * `DO` - Dominican Republic + * `EC` - Ecuador + * `EG` - Egypt + * `SV` - El Salvador + * `GQ` - Equatorial Guinea + * `ER` - Eritrea + * `EE` - Estonia + * `SZ` - Eswatini + * `ET` - Ethiopia + * `FK` - Falkland Islands (Malvinas) + * `FO` - Faroe Islands + * `FJ` - Fiji + * `FI` - Finland + * `FR` - France + * `GF` - French Guiana + * `PF` - French Polynesia + * `TF` - French Southern Territories + * `GA` - Gabon + * `GM` - Gambia + * `GE` - Georgia + * `DE` - Germany + * `GH` - Ghana + * `GI` - Gibraltar + * `GR` - Greece + * `GL` - Greenland + * `GD` - Grenada + * `GP` - Guadeloupe + * `GU` - Guam + * `GT` - Guatemala + * `GG` - Guernsey + * `GN` - Guinea + * `GW` - Guinea-Bissau + * `GY` - Guyana + * `HT` - Haiti + * `HM` - Heard Island and McDonald Islands + * `VA` - Holy See + * `HN` - Honduras + * `HK` - Hong Kong + * `HU` - Hungary + * `IS` - Iceland + * `IN` - India + * `ID` - Indonesia + * `IR` - Iran + * `IQ` - Iraq + * `IE` - Ireland + * `IM` - Isle of Man + * `IL` - Israel + * `IT` - Italy + * `JM` - Jamaica + * `JP` - Japan + * `JE` - Jersey + * `JO` - Jordan + * `KZ` - Kazakhstan + * `KE` - Kenya + * `KI` - Kiribati + * `KW` - Kuwait + * `KG` - Kyrgyzstan + * `LA` - Laos + * `LV` - Latvia + * `LB` - Lebanon + * `LS` - Lesotho + * `LR` - Liberia + * `LY` - Libya + * `LI` - Liechtenstein + * `LT` - Lithuania + * `LU` - Luxembourg + * `MO` - Macao + * `MG` - Madagascar + * `MW` - Malawi + * `MY` - Malaysia + * `MV` - Maldives + * `ML` - Mali + * `MT` - Malta + * `MH` - Marshall Islands + * `MQ` - Martinique + * `MR` - Mauritania + * `MU` - Mauritius + * `YT` - Mayotte + * `MX` - Mexico + * `FM` - Micronesia (Federated States of) + * `MD` - Moldova + * `MC` - Monaco + * `MN` - Mongolia + * `ME` - Montenegro + * `MS` - Montserrat + * `MA` - Morocco + * `MZ` - Mozambique + * `MM` - Myanmar + * `NA` - Namibia + * `NR` - Nauru + * `NP` - Nepal + * `NL` - Netherlands + * `NC` - New Caledonia + * `NZ` - New Zealand + * `NI` - Nicaragua + * `NE` - Niger + * `NG` - Nigeria + * `NU` - Niue + * `NF` - Norfolk Island + * `KP` - North Korea + * `MK` - North Macedonia + * `MP` - Northern Mariana Islands + * `NO` - Norway + * `OM` - Oman + * `PK` - Pakistan + * `PW` - Palau + * `PS` - Palestine, State of + * `PA` - Panama + * `PG` - Papua New Guinea + * `PY` - Paraguay + * `PE` - Peru + * `PH` - Philippines + * `PN` - Pitcairn + * `PL` - Poland + * `PT` - Portugal + * `PR` - Puerto Rico + * `QA` - Qatar + * `RE` - Réunion + * `RO` - Romania + * `RU` - Russia + * `RW` - Rwanda + * `BL` - Saint Barthélemy + * `SH` - Saint Helena, Ascension and Tristan da Cunha + * `KN` - Saint Kitts and Nevis + * `LC` - Saint Lucia + * `MF` - Saint Martin (French part) + * `PM` - Saint Pierre and Miquelon + * `VC` - Saint Vincent and the Grenadines + * `WS` - Samoa + * `SM` - San Marino + * `ST` - Sao Tome and Principe + * `SA` - Saudi Arabia + * `SN` - Senegal + * `RS` - Serbia + * `SC` - Seychelles + * `SL` - Sierra Leone + * `SG` - Singapore + * `SX` - Sint Maarten (Dutch part) + * `SK` - Slovakia + * `SI` - Slovenia + * `SB` - Solomon Islands + * `SO` - Somalia + * `ZA` - South Africa + * `GS` - South Georgia and the South Sandwich Islands + * `KR` - South Korea + * `SS` - South Sudan + * `ES` - Spain + * `LK` - Sri Lanka + * `SD` - Sudan + * `SR` - Suriname + * `SJ` - Svalbard and Jan Mayen + * `SE` - Sweden + * `CH` - Switzerland + * `SY` - Syria + * `TW` - Taiwan + * `TJ` - Tajikistan + * `TZ` - Tanzania + * `TH` - Thailand + * `TL` - Timor-Leste + * `TG` - Togo + * `TK` - Tokelau + * `TO` - Tonga + * `TT` - Trinidad and Tobago + * `TN` - Tunisia + * `TR` - Turkey + * `TM` - Turkmenistan + * `TC` - Turks and Caicos Islands + * `TV` - Tuvalu + * `UG` - Uganda + * `UA` - Ukraine + * `AE` - United Arab Emirates + * `GB` - United Kingdom + * `UM` - United States Minor Outlying Islands + * `US` - United States of America + * `UY` - Uruguay + * `UZ` - Uzbekistan + * `VU` - Vanuatu + * `VE` - Venezuela + * `VN` - Vietnam + * `VG` - Virgin Islands (British) + * `VI` - Virgin Islands (U.S.) + * `WF` - Wallis and Futuna + * `EH` - Western Sahara + * `YE` - Yemen + * `ZM` - Zambia + * `ZW` - Zimbabwe + source: + openapi: openapi/openapi.yml + CreditNoteStatus: + discriminated: false + docs: |- + The credit note's status. - * `ZWL` - Zimbabwean Dollar (2009) + * `SUBMITTED` - SUBMITTED + * `AUTHORIZED` - AUTHORIZED + * `PAID` - PAID union: - - TransactionCurrencyEnum + - CreditNoteStatusEnum - string source: openapi: openapi/openapi.yml inline: true - CreditNoteRequestPaymentsItem: + CreditNoteContact: discriminated: false + docs: The credit note's contact. union: - type: string validation: format: uuid - - Payment + - Contact source: openapi: openapi/openapi.yml inline: true - CreditNoteRequestAppliedPaymentsItem: + CreditNoteCompany: discriminated: false + docs: The company the credit note belongs to. union: - type: string validation: format: uuid - - PaymentLineItem + - CompanyInfo source: openapi: openapi/openapi.yml inline: true - CreditNoteRequestAccountingPeriod: + CreditNoteTrackingCategoriesItem: discriminated: false - docs: The accounting period that the CreditNote was generated in. union: - type: string validation: format: uuid - - AccountingPeriod + - TrackingCategory source: openapi: openapi/openapi.yml inline: true - CreditNoteRequest: + CreditNoteCurrency: + discriminated: false docs: >- - # The CreditNote Object - - ### Description - - A `CreditNote` is transaction issued to a customer, indicating a reduction - or cancellation of the amount owed by the customer. It is most generally - used as an adjustment note used to rectify errors, returns, or - overpayments related to a sales transaction. A `CreditNote` can be applied - to *Accounts Receivable* Invoices to decrease the overall amount of the - Invoice. - - - ### Usage Example - - Fetch from the `LIST CreditNotes` endpoint and view a company's credit - notes. - properties: - transaction_date: - type: optional - docs: The credit note's transaction date. - status: - type: optional - docs: |- - The credit note's status. - - * `SUBMITTED` - SUBMITTED - * `AUTHORIZED` - AUTHORIZED - * `PAID` - PAID - number: - type: optional - docs: The credit note's number. - contact: - type: optional - docs: The credit note's contact. - company: - type: optional - docs: The company the credit note belongs to. - exchange_rate: - type: optional - docs: The credit note's exchange rate. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - total_amount: - type: optional - docs: The credit note's total amount. - remaining_credit: - type: optional - docs: >- - The amount of value remaining in the credit note that the customer can - use. - inclusive_of_tax: - type: optional - docs: >- - If the transaction is inclusive or exclusive of tax. `True` if - inclusive, `False` if exclusive. - line_items: optional> - tracking_categories: optional>> - currency: - type: optional - docs: >- - The credit note's currency. - - - * `XUA` - ADB Unit of Account - - * `AFN` - Afghan Afghani - - * `AFA` - Afghan Afghani (1927–2002) - - * `ALL` - Albanian Lek - - * `ALK` - Albanian Lek (1946–1965) - - * `DZD` - Algerian Dinar - - * `ADP` - Andorran Peseta - - * `AOA` - Angolan Kwanza - - * `AOK` - Angolan Kwanza (1977–1991) - - * `AON` - Angolan New Kwanza (1990–2000) - - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - - * `ARA` - Argentine Austral - - * `ARS` - Argentine Peso - - * `ARM` - Argentine Peso (1881–1970) - - * `ARP` - Argentine Peso (1983–1985) - - * `ARL` - Argentine Peso Ley (1970–1983) - - * `AMD` - Armenian Dram - - * `AWG` - Aruban Florin - - * `AUD` - Australian Dollar - - * `ATS` - Austrian Schilling - - * `AZN` - Azerbaijani Manat - - * `AZM` - Azerbaijani Manat (1993–2006) + The credit note's currency. - * `BSD` - Bahamian Dollar - * `BHD` - Bahraini Dinar + * `XUA` - ADB Unit of Account - * `BDT` - Bangladeshi Taka + * `AFN` - Afghan Afghani - * `BBD` - Barbadian Dollar + * `AFA` - Afghan Afghani (1927–2002) - * `BYN` - Belarusian Ruble + * `ALL` - Albanian Lek - * `BYB` - Belarusian Ruble (1994–1999) + * `ALK` - Albanian Lek (1946–1965) - * `BYR` - Belarusian Ruble (2000–2016) + * `DZD` - Algerian Dinar - * `BEF` - Belgian Franc + * `ADP` - Andorran Peseta - * `BEC` - Belgian Franc (convertible) + * `AOA` - Angolan Kwanza - * `BEL` - Belgian Franc (financial) + * `AOK` - Angolan Kwanza (1977–1991) - * `BZD` - Belize Dollar + * `AON` - Angolan New Kwanza (1990–2000) - * `BMD` - Bermudan Dollar + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `BTN` - Bhutanese Ngultrum + * `ARA` - Argentine Austral - * `BOB` - Bolivian Boliviano + * `ARS` - Argentine Peso - * `BOL` - Bolivian Boliviano (1863–1963) + * `ARM` - Argentine Peso (1881–1970) - * `BOV` - Bolivian Mvdol + * `ARP` - Argentine Peso (1983–1985) - * `BOP` - Bolivian Peso + * `ARL` - Argentine Peso Ley (1970–1983) - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `AMD` - Armenian Dram - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `AWG` - Aruban Florin - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `AUD` - Australian Dollar - * `BWP` - Botswanan Pula + * `ATS` - Austrian Schilling - * `BRC` - Brazilian Cruzado (1986–1989) + * `AZN` - Azerbaijani Manat - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `AZM` - Azerbaijani Manat (1993–2006) - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BSD` - Bahamian Dollar - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BHD` - Bahraini Dinar - * `BRN` - Brazilian New Cruzado (1989–1990) + * `BDT` - Bangladeshi Taka - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `BBD` - Barbadian Dollar - * `BRL` - Brazilian Real + * `BYN` - Belarusian Ruble - * `GBP` - British Pound + * `BYB` - Belarusian Ruble (1994–1999) - * `BND` - Brunei Dollar + * `BYR` - Belarusian Ruble (2000–2016) - * `BGL` - Bulgarian Hard Lev + * `BEF` - Belgian Franc - * `BGN` - Bulgarian Lev + * `BEC` - Belgian Franc (convertible) - * `BGO` - Bulgarian Lev (1879–1952) + * `BEL` - Belgian Franc (financial) - * `BGM` - Bulgarian Socialist Lev + * `BZD` - Belize Dollar - * `BUK` - Burmese Kyat + * `BMD` - Bermudan Dollar - * `BIF` - Burundian Franc + * `BTN` - Bhutanese Ngultrum - * `XPF` - CFP Franc + * `BOB` - Bolivian Boliviano - * `KHR` - Cambodian Riel + * `BOL` - Bolivian Boliviano (1863–1963) - * `CAD` - Canadian Dollar + * `BOV` - Bolivian Mvdol - * `CVE` - Cape Verdean Escudo + * `BOP` - Bolivian Peso - * `KYD` - Cayman Islands Dollar + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `XAF` - Central African CFA Franc + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `CLE` - Chilean Escudo + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `CLP` - Chilean Peso + * `BWP` - Botswanan Pula - * `CLF` - Chilean Unit of Account (UF) + * `BRC` - Brazilian Cruzado (1986–1989) - * `CNX` - Chinese People’s Bank Dollar + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `CNY` - Chinese Yuan + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `CNH` - Chinese Yuan (offshore) + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `COP` - Colombian Peso + * `BRN` - Brazilian New Cruzado (1989–1990) - * `COU` - Colombian Real Value Unit + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `KMF` - Comorian Franc + * `BRL` - Brazilian Real - * `CDF` - Congolese Franc + * `GBP` - British Pound - * `CRC` - Costa Rican Colón + * `BND` - Brunei Dollar - * `HRD` - Croatian Dinar + * `BGL` - Bulgarian Hard Lev - * `HRK` - Croatian Kuna + * `BGN` - Bulgarian Lev - * `CUC` - Cuban Convertible Peso + * `BGO` - Bulgarian Lev (1879–1952) - * `CUP` - Cuban Peso + * `BGM` - Bulgarian Socialist Lev - * `CYP` - Cypriot Pound + * `BUK` - Burmese Kyat - * `CZK` - Czech Koruna + * `BIF` - Burundian Franc - * `CSK` - Czechoslovak Hard Koruna + * `XPF` - CFP Franc - * `DKK` - Danish Krone + * `KHR` - Cambodian Riel - * `DJF` - Djiboutian Franc + * `CAD` - Canadian Dollar - * `DOP` - Dominican Peso + * `CVE` - Cape Verdean Escudo - * `NLG` - Dutch Guilder + * `KYD` - Cayman Islands Dollar - * `XCD` - East Caribbean Dollar + * `XAF` - Central African CFA Franc - * `DDM` - East German Mark + * `CLE` - Chilean Escudo - * `ECS` - Ecuadorian Sucre + * `CLP` - Chilean Peso - * `ECV` - Ecuadorian Unit of Constant Value + * `CLF` - Chilean Unit of Account (UF) - * `EGP` - Egyptian Pound + * `CNX` - Chinese People’s Bank Dollar - * `GQE` - Equatorial Guinean Ekwele + * `CNY` - Chinese Yuan - * `ERN` - Eritrean Nakfa + * `CNH` - Chinese Yuan (offshore) - * `EEK` - Estonian Kroon + * `COP` - Colombian Peso - * `ETB` - Ethiopian Birr + * `COU` - Colombian Real Value Unit - * `EUR` - Euro + * `KMF` - Comorian Franc - * `XBA` - European Composite Unit + * `CDF` - Congolese Franc - * `XEU` - European Currency Unit + * `CRC` - Costa Rican Colón - * `XBB` - European Monetary Unit + * `HRD` - Croatian Dinar - * `XBC` - European Unit of Account (XBC) + * `HRK` - Croatian Kuna - * `XBD` - European Unit of Account (XBD) + * `CUC` - Cuban Convertible Peso - * `FKP` - Falkland Islands Pound + * `CUP` - Cuban Peso - * `FJD` - Fijian Dollar + * `CYP` - Cypriot Pound - * `FIM` - Finnish Markka + * `CZK` - Czech Koruna - * `FRF` - French Franc + * `CSK` - Czechoslovak Hard Koruna - * `XFO` - French Gold Franc + * `DKK` - Danish Krone - * `XFU` - French UIC-Franc + * `DJF` - Djiboutian Franc - * `GMD` - Gambian Dalasi + * `DOP` - Dominican Peso - * `GEK` - Georgian Kupon Larit + * `NLG` - Dutch Guilder - * `GEL` - Georgian Lari + * `XCD` - East Caribbean Dollar - * `DEM` - German Mark + * `DDM` - East German Mark - * `GHS` - Ghanaian Cedi + * `ECS` - Ecuadorian Sucre - * `GHC` - Ghanaian Cedi (1979–2007) + * `ECV` - Ecuadorian Unit of Constant Value - * `GIP` - Gibraltar Pound + * `EGP` - Egyptian Pound - * `XAU` - Gold + * `GQE` - Equatorial Guinean Ekwele - * `GRD` - Greek Drachma + * `ERN` - Eritrean Nakfa - * `GTQ` - Guatemalan Quetzal + * `EEK` - Estonian Kroon - * `GWP` - Guinea-Bissau Peso + * `ETB` - Ethiopian Birr - * `GNF` - Guinean Franc + * `EUR` - Euro - * `GNS` - Guinean Syli + * `XBA` - European Composite Unit - * `GYD` - Guyanaese Dollar + * `XEU` - European Currency Unit - * `HTG` - Haitian Gourde + * `XBB` - European Monetary Unit - * `HNL` - Honduran Lempira + * `XBC` - European Unit of Account (XBC) - * `HKD` - Hong Kong Dollar + * `XBD` - European Unit of Account (XBD) - * `HUF` - Hungarian Forint + * `FKP` - Falkland Islands Pound - * `IMP` - IMP + * `FJD` - Fijian Dollar - * `ISK` - Icelandic Króna + * `FIM` - Finnish Markka - * `ISJ` - Icelandic Króna (1918–1981) + * `FRF` - French Franc - * `INR` - Indian Rupee + * `XFO` - French Gold Franc - * `IDR` - Indonesian Rupiah + * `XFU` - French UIC-Franc - * `IRR` - Iranian Rial + * `GMD` - Gambian Dalasi - * `IQD` - Iraqi Dinar + * `GEK` - Georgian Kupon Larit - * `IEP` - Irish Pound + * `GEL` - Georgian Lari - * `ILS` - Israeli New Shekel + * `DEM` - German Mark - * `ILP` - Israeli Pound + * `GHS` - Ghanaian Cedi - * `ILR` - Israeli Shekel (1980–1985) + * `GHC` - Ghanaian Cedi (1979–2007) - * `ITL` - Italian Lira + * `GIP` - Gibraltar Pound - * `JMD` - Jamaican Dollar + * `XAU` - Gold - * `JPY` - Japanese Yen + * `GRD` - Greek Drachma - * `JOD` - Jordanian Dinar + * `GTQ` - Guatemalan Quetzal - * `KZT` - Kazakhstani Tenge + * `GWP` - Guinea-Bissau Peso - * `KES` - Kenyan Shilling + * `GNF` - Guinean Franc - * `KWD` - Kuwaiti Dinar + * `GNS` - Guinean Syli - * `KGS` - Kyrgystani Som + * `GYD` - Guyanaese Dollar - * `LAK` - Laotian Kip + * `HTG` - Haitian Gourde - * `LVL` - Latvian Lats + * `HNL` - Honduran Lempira - * `LVR` - Latvian Ruble + * `HKD` - Hong Kong Dollar - * `LBP` - Lebanese Pound + * `HUF` - Hungarian Forint - * `LSL` - Lesotho Loti + * `IMP` - IMP - * `LRD` - Liberian Dollar + * `ISK` - Icelandic Króna - * `LYD` - Libyan Dinar + * `ISJ` - Icelandic Króna (1918–1981) - * `LTL` - Lithuanian Litas + * `INR` - Indian Rupee - * `LTT` - Lithuanian Talonas + * `IDR` - Indonesian Rupiah - * `LUL` - Luxembourg Financial Franc + * `IRR` - Iranian Rial - * `LUC` - Luxembourgian Convertible Franc + * `IQD` - Iraqi Dinar - * `LUF` - Luxembourgian Franc + * `IEP` - Irish Pound - * `MOP` - Macanese Pataca + * `ILS` - Israeli New Shekel - * `MKD` - Macedonian Denar + * `ILP` - Israeli Pound - * `MKN` - Macedonian Denar (1992–1993) + * `ILR` - Israeli Shekel (1980–1985) - * `MGA` - Malagasy Ariary + * `ITL` - Italian Lira - * `MGF` - Malagasy Franc + * `JMD` - Jamaican Dollar - * `MWK` - Malawian Kwacha + * `JPY` - Japanese Yen - * `MYR` - Malaysian Ringgit + * `JOD` - Jordanian Dinar - * `MVR` - Maldivian Rufiyaa + * `KZT` - Kazakhstani Tenge - * `MVP` - Maldivian Rupee (1947–1981) + * `KES` - Kenyan Shilling - * `MLF` - Malian Franc + * `KWD` - Kuwaiti Dinar - * `MTL` - Maltese Lira + * `KGS` - Kyrgystani Som - * `MTP` - Maltese Pound + * `LAK` - Laotian Kip - * `MRU` - Mauritanian Ouguiya + * `LVL` - Latvian Lats - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `LVR` - Latvian Ruble - * `MUR` - Mauritian Rupee + * `LBP` - Lebanese Pound - * `MXV` - Mexican Investment Unit + * `LSL` - Lesotho Loti - * `MXN` - Mexican Peso + * `LRD` - Liberian Dollar - * `MXP` - Mexican Silver Peso (1861–1992) + * `LYD` - Libyan Dinar - * `MDC` - Moldovan Cupon + * `LTL` - Lithuanian Litas - * `MDL` - Moldovan Leu + * `LTT` - Lithuanian Talonas - * `MCF` - Monegasque Franc + * `LUL` - Luxembourg Financial Franc - * `MNT` - Mongolian Tugrik + * `LUC` - Luxembourgian Convertible Franc - * `MAD` - Moroccan Dirham + * `LUF` - Luxembourgian Franc - * `MAF` - Moroccan Franc + * `MOP` - Macanese Pataca - * `MZE` - Mozambican Escudo + * `MKD` - Macedonian Denar - * `MZN` - Mozambican Metical + * `MKN` - Macedonian Denar (1992–1993) - * `MZM` - Mozambican Metical (1980–2006) + * `MGA` - Malagasy Ariary - * `MMK` - Myanmar Kyat + * `MGF` - Malagasy Franc - * `NAD` - Namibian Dollar + * `MWK` - Malawian Kwacha - * `NPR` - Nepalese Rupee + * `MYR` - Malaysian Ringgit - * `ANG` - Netherlands Antillean Guilder + * `MVR` - Maldivian Rufiyaa - * `TWD` - New Taiwan Dollar + * `MVP` - Maldivian Rupee (1947–1981) - * `NZD` - New Zealand Dollar + * `MLF` - Malian Franc - * `NIO` - Nicaraguan Córdoba + * `MTL` - Maltese Lira - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `MTP` - Maltese Pound - * `NGN` - Nigerian Naira + * `MRU` - Mauritanian Ouguiya - * `KPW` - North Korean Won + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `NOK` - Norwegian Krone + * `MUR` - Mauritian Rupee - * `OMR` - Omani Rial + * `MXV` - Mexican Investment Unit - * `PKR` - Pakistani Rupee + * `MXN` - Mexican Peso - * `XPD` - Palladium + * `MXP` - Mexican Silver Peso (1861–1992) - * `PAB` - Panamanian Balboa + * `MDC` - Moldovan Cupon - * `PGK` - Papua New Guinean Kina + * `MDL` - Moldovan Leu - * `PYG` - Paraguayan Guarani + * `MCF` - Monegasque Franc - * `PEI` - Peruvian Inti + * `MNT` - Mongolian Tugrik - * `PEN` - Peruvian Sol + * `MAD` - Moroccan Dirham - * `PES` - Peruvian Sol (1863–1965) + * `MAF` - Moroccan Franc - * `PHP` - Philippine Peso + * `MZE` - Mozambican Escudo - * `XPT` - Platinum + * `MZN` - Mozambican Metical - * `PLN` - Polish Zloty + * `MZM` - Mozambican Metical (1980–2006) - * `PLZ` - Polish Zloty (1950–1995) + * `MMK` - Myanmar Kyat - * `PTE` - Portuguese Escudo + * `NAD` - Namibian Dollar - * `GWE` - Portuguese Guinea Escudo + * `NPR` - Nepalese Rupee - * `QAR` - Qatari Rial + * `ANG` - Netherlands Antillean Guilder - * `XRE` - RINET Funds + * `TWD` - New Taiwan Dollar - * `RHD` - Rhodesian Dollar + * `NZD` - New Zealand Dollar - * `RON` - Romanian Leu + * `NIO` - Nicaraguan Córdoba - * `ROL` - Romanian Leu (1952–2006) + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `RUB` - Russian Ruble + * `NGN` - Nigerian Naira - * `RUR` - Russian Ruble (1991–1998) + * `KPW` - North Korean Won - * `RWF` - Rwandan Franc + * `NOK` - Norwegian Krone - * `SVC` - Salvadoran Colón + * `OMR` - Omani Rial - * `WST` - Samoan Tala + * `PKR` - Pakistani Rupee - * `SAR` - Saudi Riyal + * `XPD` - Palladium - * `RSD` - Serbian Dinar + * `PAB` - Panamanian Balboa - * `CSD` - Serbian Dinar (2002–2006) + * `PGK` - Papua New Guinean Kina - * `SCR` - Seychellois Rupee + * `PYG` - Paraguayan Guarani - * `SLL` - Sierra Leonean Leone + * `PEI` - Peruvian Inti - * `XAG` - Silver + * `PEN` - Peruvian Sol - * `SGD` - Singapore Dollar + * `PES` - Peruvian Sol (1863–1965) - * `SKK` - Slovak Koruna + * `PHP` - Philippine Peso - * `SIT` - Slovenian Tolar + * `XPT` - Platinum - * `SBD` - Solomon Islands Dollar + * `PLN` - Polish Zloty - * `SOS` - Somali Shilling + * `PLZ` - Polish Zloty (1950–1995) - * `ZAR` - South African Rand + * `PTE` - Portuguese Escudo - * `ZAL` - South African Rand (financial) + * `GWE` - Portuguese Guinea Escudo - * `KRH` - South Korean Hwan (1953–1962) + * `QAR` - Qatari Rial - * `KRW` - South Korean Won + * `XRE` - RINET Funds - * `KRO` - South Korean Won (1945–1953) + * `RHD` - Rhodesian Dollar - * `SSP` - South Sudanese Pound + * `RON` - Romanian Leu - * `SUR` - Soviet Rouble + * `ROL` - Romanian Leu (1952–2006) - * `ESP` - Spanish Peseta + * `RUB` - Russian Ruble - * `ESA` - Spanish Peseta (A account) + * `RUR` - Russian Ruble (1991–1998) - * `ESB` - Spanish Peseta (convertible account) + * `RWF` - Rwandan Franc - * `XDR` - Special Drawing Rights + * `SVC` - Salvadoran Colón - * `LKR` - Sri Lankan Rupee + * `WST` - Samoan Tala - * `SHP` - St. Helena Pound + * `SAR` - Saudi Riyal - * `XSU` - Sucre + * `RSD` - Serbian Dinar - * `SDD` - Sudanese Dinar (1992–2007) + * `CSD` - Serbian Dinar (2002–2006) - * `SDG` - Sudanese Pound + * `SCR` - Seychellois Rupee - * `SDP` - Sudanese Pound (1957–1998) + * `SLL` - Sierra Leonean Leone - * `SRD` - Surinamese Dollar + * `XAG` - Silver - * `SRG` - Surinamese Guilder + * `SGD` - Singapore Dollar - * `SZL` - Swazi Lilangeni + * `SKK` - Slovak Koruna - * `SEK` - Swedish Krona + * `SIT` - Slovenian Tolar - * `CHF` - Swiss Franc + * `SBD` - Solomon Islands Dollar - * `SYP` - Syrian Pound + * `SOS` - Somali Shilling - * `STN` - São Tomé & Príncipe Dobra + * `ZAR` - South African Rand - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `ZAL` - South African Rand (financial) - * `TVD` - TVD + * `KRH` - South Korean Hwan (1953–1962) - * `TJR` - Tajikistani Ruble + * `KRW` - South Korean Won - * `TJS` - Tajikistani Somoni + * `KRO` - South Korean Won (1945–1953) - * `TZS` - Tanzanian Shilling + * `SSP` - South Sudanese Pound - * `XTS` - Testing Currency Code + * `SUR` - Soviet Rouble - * `THB` - Thai Baht + * `ESP` - Spanish Peseta - * `XXX` - The codes assigned for transactions where no currency is - involved + * `ESA` - Spanish Peseta (A account) - * `TPE` - Timorese Escudo + * `ESB` - Spanish Peseta (convertible account) - * `TOP` - Tongan Paʻanga + * `XDR` - Special Drawing Rights - * `TTD` - Trinidad & Tobago Dollar + * `LKR` - Sri Lankan Rupee - * `TND` - Tunisian Dinar + * `SHP` - St. Helena Pound - * `TRY` - Turkish Lira + * `XSU` - Sucre - * `TRL` - Turkish Lira (1922–2005) + * `SDD` - Sudanese Dinar (1992–2007) - * `TMT` - Turkmenistani Manat + * `SDG` - Sudanese Pound - * `TMM` - Turkmenistani Manat (1993–2009) + * `SDP` - Sudanese Pound (1957–1998) - * `USD` - US Dollar + * `SRD` - Surinamese Dollar - * `USN` - US Dollar (Next day) + * `SRG` - Surinamese Guilder - * `USS` - US Dollar (Same day) + * `SZL` - Swazi Lilangeni - * `UGX` - Ugandan Shilling + * `SEK` - Swedish Krona - * `UGS` - Ugandan Shilling (1966–1987) + * `CHF` - Swiss Franc - * `UAH` - Ukrainian Hryvnia + * `SYP` - Syrian Pound - * `UAK` - Ukrainian Karbovanets + * `STN` - São Tomé & Príncipe Dobra - * `AED` - United Arab Emirates Dirham + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `UYW` - Uruguayan Nominal Wage Index Unit + * `TVD` - TVD - * `UYU` - Uruguayan Peso + * `TJR` - Tajikistani Ruble - * `UYP` - Uruguayan Peso (1975–1993) + * `TJS` - Tajikistani Somoni - * `UYI` - Uruguayan Peso (Indexed Units) + * `TZS` - Tanzanian Shilling - * `UZS` - Uzbekistani Som + * `XTS` - Testing Currency Code - * `VUV` - Vanuatu Vatu + * `THB` - Thai Baht - * `VES` - Venezuelan Bolívar + * `XXX` - The codes assigned for transactions where no currency is + involved - * `VEB` - Venezuelan Bolívar (1871–2008) + * `TPE` - Timorese Escudo - * `VEF` - Venezuelan Bolívar (2008–2018) + * `TOP` - Tongan Paʻanga - * `VND` - Vietnamese Dong + * `TTD` - Trinidad & Tobago Dollar - * `VNN` - Vietnamese Dong (1978–1985) + * `TND` - Tunisian Dinar - * `CHE` - WIR Euro + * `TRY` - Turkish Lira - * `CHW` - WIR Franc + * `TRL` - Turkish Lira (1922–2005) - * `XOF` - West African CFA Franc + * `TMT` - Turkmenistani Manat - * `YDD` - Yemeni Dinar + * `TMM` - Turkmenistani Manat (1993–2009) - * `YER` - Yemeni Rial + * `USD` - US Dollar - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `USN` - US Dollar (Next day) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `USS` - US Dollar (Same day) - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `UGX` - Ugandan Shilling - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `UGS` - Ugandan Shilling (1966–1987) - * `ZWN` - ZWN + * `UAH` - Ukrainian Hryvnia - * `ZRN` - Zairean New Zaire (1993–1998) + * `UAK` - Ukrainian Karbovanets - * `ZRZ` - Zairean Zaire (1971–1993) + * `AED` - United Arab Emirates Dirham - * `ZMW` - Zambian Kwacha + * `UYW` - Uruguayan Nominal Wage Index Unit - * `ZMK` - Zambian Kwacha (1968–2012) + * `UYU` - Uruguayan Peso - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `UYP` - Uruguayan Peso (1975–1993) - * `ZWR` - Zimbabwean Dollar (2008) + * `UYI` - Uruguayan Peso (Indexed Units) - * `ZWL` - Zimbabwean Dollar (2009) - payments: - type: optional>> - docs: Array of `Payment` object IDs - applied_payments: - type: optional>> - docs: >- - A list of the Payment Applied to Lines common models related to a - given Invoice, Credit Note, or Journal Entry. - accounting_period: - type: optional - docs: The accounting period that the CreditNote was generated in. - applied_to_lines: - type: optional> - docs: >- - A list of the CreditNote Applied to Lines common models related to a - given Credit Note - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - CreditNoteResponse: - properties: - model: CreditNote - warnings: list - errors: list - logs: optional> - source: - openapi: openapi/openapi.yml - CreditNoteStatusEnum: - enum: - - SUBMITTED - - AUTHORIZED - - PAID - docs: |- - * `SUBMITTED` - SUBMITTED - * `AUTHORIZED` - AUTHORIZED - * `PAID` - PAID - source: - openapi: openapi/openapi.yml - CreditOrDebitEnum: - enum: - - CREDIT - - DEBIT - docs: |- - * `CREDIT` - CREDIT - * `DEBIT` - DEBIT - source: - openapi: openapi/openapi.yml - DataPassthroughRequestMethod: - discriminated: false - union: - - MethodEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - DataPassthroughRequest: - docs: >- - # The DataPassthrough Object + * `UZS` - Uzbekistani Som - ### Description + * `VUV` - Vanuatu Vatu - The `DataPassthrough` object is used to send information to an - otherwise-unsupported third-party endpoint. + * `VES` - Venezuelan Bolívar + * `VEB` - Venezuelan Bolívar (1871–2008) - ### Usage Example + * `VEF` - Venezuelan Bolívar (2008–2018) - Create a `DataPassthrough` to get team hierarchies from your Rippling - integration. - properties: - method: DataPassthroughRequestMethod - path: - type: string - docs: The path of the request in the third party's platform. - validation: - minLength: 1 - base_url_override: - type: optional - docs: An optional override of the third party's base url for the request. - validation: - minLength: 1 - data: - type: optional - docs: >- - The data with the request. You must include a `request_format` - parameter matching the data's format - validation: - minLength: 1 - multipart_form_data: - type: optional> - docs: >- - Pass an array of `MultipartFormField` objects in here instead of using - the `data` param if `request_format` is set to `MULTIPART`. - headers: - type: optional> - docs: >- - The headers to use for the request (Merge will handle the account's - authorization headers). `Content-Type` header is required for - passthrough. Choose content type corresponding to expected format of - receiving server. - request_format: optional - normalize_response: - type: optional - docs: >- - Optional. If true, the response will always be an object of the form - `{"type": T, "value": ...}` where `T` will be one of `string, boolean, - number, null, array, object`. - source: - openapi: openapi/openapi.yml - DebugModeLog: - properties: - log_id: string - dashboard_view: string - log_summary: DebugModelLogSummary + * `VND` - Vietnamese Dong + + * `VNN` - Vietnamese Dong (1978–1985) + + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) + union: + - TransactionCurrencyEnum + - string source: openapi: openapi/openapi.yml - DebugModelLogSummary: - properties: - url: string - method: string - status_code: integer + inline: true + CreditNotePaymentsItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - Payment source: openapi: openapi/openapi.yml - EmployeeCompany: + inline: true + CreditNoteAppliedPaymentsItem: discriminated: false - docs: The subsidiary that the employee belongs to. union: - type: string validation: format: uuid - - CompanyInfo + - PaymentLineItem source: openapi: openapi/openapi.yml inline: true - EmployeeStatus: + CreditNoteAccountingPeriod: discriminated: false - docs: |- - The employee's status in the accounting system. - - * `ACTIVE` - ACTIVE - * `INACTIVE` - INACTIVE + docs: The accounting period that the CreditNote was generated in. union: - - Status895Enum - - string + - type: string + validation: + format: uuid + - AccountingPeriod source: openapi: openapi/openapi.yml inline: true - Employee: + CreditNote: docs: >- - # The Employee Object + # The CreditNote Object ### Description - An `Employee` is an individual who works for the company of the linked - account. The `Employee` model contains both contractors and full time - employees. - - * An `Employee` is a contractor if `is_contractor` property is `True` - - * An `Employee` is a full time employee if `is_contractor` property is - `False` + A `CreditNote` is transaction issued to a customer, indicating a reduction + or cancellation of the amount owed by the customer. It is most generally + used as an adjustment note used to rectify errors, returns, or + overpayments related to a sales transaction. A `CreditNote` can be applied + to *Accounts Receivable* Invoices to decrease the overall amount of the + Invoice. ### Usage Example - Fetch from the `LIST Employees` endpoint and view a company's employees. + Fetch from the `LIST CreditNotes` endpoint and view a company's credit + notes. properties: id: type: optional @@ -16019,2306 +10854,2913 @@ types: type: optional docs: The datetime that this object was modified by Merge. access: read-only - first_name: - type: optional - docs: The employee's first name. - validation: - maxLength: 255 - last_name: - type: optional - docs: The employee's last name. - validation: - maxLength: 255 - is_contractor: - type: optional - docs: '`True` if the employee is a contractor, `False` if not.' - employee_number: - type: optional - docs: The employee's internal identification number. - validation: - maxLength: 50 - email_address: - type: optional - docs: The employee's email address. - company: - type: optional - docs: The subsidiary that the employee belongs to. + transaction_date: + type: optional + docs: The credit note's transaction date. status: - type: EmployeeStatus + type: optional docs: |- - The employee's status in the accounting system. + The credit note's status. - * `ACTIVE` - ACTIVE - * `INACTIVE` - INACTIVE - remote_was_deleted: + * `SUBMITTED` - SUBMITTED + * `AUTHORIZED` - AUTHORIZED + * `PAID` - PAID + number: + type: optional + docs: The credit note's number. + contact: + type: optional + docs: The credit note's contact. + company: + type: optional + docs: The company the credit note belongs to. + exchange_rate: + type: optional + docs: The credit note's exchange rate. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + total_amount: + type: optional + docs: The credit note's total amount. + remaining_credit: + type: optional + docs: >- + The amount of value remaining in the credit note that the customer can + use. + inclusive_of_tax: type: optional docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> + If the transaction is inclusive or exclusive of tax. `True` if + inclusive, `False` if exclusive. + line_items: + type: optional> access: read-only - source: - openapi: openapi/openapi.yml - EnabledActionsEnum: - enum: - - READ - - WRITE - docs: |- - * `READ` - READ - * `WRITE` - WRITE - source: - openapi: openapi/openapi.yml - EncodingEnum: - enum: - - RAW - - BASE64 - - GZIP_BASE64 - docs: |- - * `RAW` - RAW - * `BASE64` - BASE64 - * `GZIP_BASE64` - GZIP_BASE64 - source: - openapi: openapi/openapi.yml - ErrorValidationProblem: - properties: - source: optional - title: string - detail: string - problem_type: string - source: - openapi: openapi/openapi.yml - EventTypeEnum: - enum: - - CREATED_REMOTE_PRODUCTION_API_KEY - - DELETED_REMOTE_PRODUCTION_API_KEY - - CREATED_TEST_API_KEY - - DELETED_TEST_API_KEY - - REGENERATED_PRODUCTION_API_KEY - - REGENERATED_WEBHOOK_SIGNATURE - - INVITED_USER - - TWO_FACTOR_AUTH_ENABLED - - TWO_FACTOR_AUTH_DISABLED - - DELETED_LINKED_ACCOUNT - - DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT - - CREATED_DESTINATION - - DELETED_DESTINATION - - CHANGED_DESTINATION - - CHANGED_SCOPES - - CHANGED_PERSONAL_INFORMATION - - CHANGED_ORGANIZATION_SETTINGS - - ENABLED_INTEGRATION - - DISABLED_INTEGRATION - - ENABLED_CATEGORY - - DISABLED_CATEGORY - - CHANGED_PASSWORD - - RESET_PASSWORD - - ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION - - ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT - - DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION - - DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT - - CREATED_INTEGRATION_WIDE_FIELD_MAPPING - - CREATED_LINKED_ACCOUNT_FIELD_MAPPING - - CHANGED_INTEGRATION_WIDE_FIELD_MAPPING - - CHANGED_LINKED_ACCOUNT_FIELD_MAPPING - - DELETED_INTEGRATION_WIDE_FIELD_MAPPING - - DELETED_LINKED_ACCOUNT_FIELD_MAPPING - - CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE - - CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE - - DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE - - FORCED_LINKED_ACCOUNT_RESYNC - - MUTED_ISSUE - - GENERATED_MAGIC_LINK - - ENABLED_MERGE_WEBHOOK - - DISABLED_MERGE_WEBHOOK - - MERGE_WEBHOOK_TARGET_CHANGED - - END_USER_CREDENTIALS_ACCESSED - docs: >- - * `CREATED_REMOTE_PRODUCTION_API_KEY` - CREATED_REMOTE_PRODUCTION_API_KEY - - * `DELETED_REMOTE_PRODUCTION_API_KEY` - DELETED_REMOTE_PRODUCTION_API_KEY - - * `CREATED_TEST_API_KEY` - CREATED_TEST_API_KEY - - * `DELETED_TEST_API_KEY` - DELETED_TEST_API_KEY - - * `REGENERATED_PRODUCTION_API_KEY` - REGENERATED_PRODUCTION_API_KEY - - * `REGENERATED_WEBHOOK_SIGNATURE` - REGENERATED_WEBHOOK_SIGNATURE - - * `INVITED_USER` - INVITED_USER - - * `TWO_FACTOR_AUTH_ENABLED` - TWO_FACTOR_AUTH_ENABLED - - * `TWO_FACTOR_AUTH_DISABLED` - TWO_FACTOR_AUTH_DISABLED - - * `DELETED_LINKED_ACCOUNT` - DELETED_LINKED_ACCOUNT - - * `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT` - - DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT - - * `CREATED_DESTINATION` - CREATED_DESTINATION - - * `DELETED_DESTINATION` - DELETED_DESTINATION - - * `CHANGED_DESTINATION` - CHANGED_DESTINATION - - * `CHANGED_SCOPES` - CHANGED_SCOPES - - * `CHANGED_PERSONAL_INFORMATION` - CHANGED_PERSONAL_INFORMATION - - * `CHANGED_ORGANIZATION_SETTINGS` - CHANGED_ORGANIZATION_SETTINGS + tracking_categories: optional>> + currency: + type: optional + docs: >- + The credit note's currency. - * `ENABLED_INTEGRATION` - ENABLED_INTEGRATION - * `DISABLED_INTEGRATION` - DISABLED_INTEGRATION + * `XUA` - ADB Unit of Account - * `ENABLED_CATEGORY` - ENABLED_CATEGORY + * `AFN` - Afghan Afghani - * `DISABLED_CATEGORY` - DISABLED_CATEGORY + * `AFA` - Afghan Afghani (1927–2002) - * `CHANGED_PASSWORD` - CHANGED_PASSWORD + * `ALL` - Albanian Lek - * `RESET_PASSWORD` - RESET_PASSWORD + * `ALK` - Albanian Lek (1946–1965) - * `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - - ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION + * `DZD` - Algerian Dinar - * `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - - ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT + * `ADP` - Andorran Peseta - * `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - - DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION + * `AOA` - Angolan Kwanza - * `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - - DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT + * `AOK` - Angolan Kwanza (1977–1991) - * `CREATED_INTEGRATION_WIDE_FIELD_MAPPING` - - CREATED_INTEGRATION_WIDE_FIELD_MAPPING + * `AON` - Angolan New Kwanza (1990–2000) - * `CREATED_LINKED_ACCOUNT_FIELD_MAPPING` - - CREATED_LINKED_ACCOUNT_FIELD_MAPPING + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING` - - CHANGED_INTEGRATION_WIDE_FIELD_MAPPING + * `ARA` - Argentine Austral - * `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING` - - CHANGED_LINKED_ACCOUNT_FIELD_MAPPING + * `ARS` - Argentine Peso - * `DELETED_INTEGRATION_WIDE_FIELD_MAPPING` - - DELETED_INTEGRATION_WIDE_FIELD_MAPPING + * `ARM` - Argentine Peso (1881–1970) - * `DELETED_LINKED_ACCOUNT_FIELD_MAPPING` - - DELETED_LINKED_ACCOUNT_FIELD_MAPPING + * `ARP` - Argentine Peso (1983–1985) - * `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - - CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE + * `ARL` - Argentine Peso Ley (1970–1983) - * `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - - CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE + * `AMD` - Armenian Dram - * `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - - DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE + * `AWG` - Aruban Florin - * `FORCED_LINKED_ACCOUNT_RESYNC` - FORCED_LINKED_ACCOUNT_RESYNC + * `AUD` - Australian Dollar - * `MUTED_ISSUE` - MUTED_ISSUE + * `ATS` - Austrian Schilling - * `GENERATED_MAGIC_LINK` - GENERATED_MAGIC_LINK + * `AZN` - Azerbaijani Manat - * `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK + * `AZM` - Azerbaijani Manat (1993–2006) - * `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK + * `BSD` - Bahamian Dollar - * `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED + * `BHD` - Bahraini Dinar - * `END_USER_CREDENTIALS_ACCESSED` - END_USER_CREDENTIALS_ACCESSED - source: - openapi: openapi/openapi.yml - ExpenseAccount: - discriminated: false - docs: The expense's payment account. - union: - - type: string - validation: - format: uuid - - Account - source: - openapi: openapi/openapi.yml - inline: true - ExpenseContact: - discriminated: false - docs: The expense's contact. - union: - - type: string - validation: - format: uuid - - Contact - source: - openapi: openapi/openapi.yml - inline: true - ExpenseCurrency: - discriminated: false - docs: >- - The expense's currency. + * `BDT` - Bangladeshi Taka + * `BBD` - Barbadian Dollar - * `XUA` - ADB Unit of Account + * `BYN` - Belarusian Ruble - * `AFN` - Afghan Afghani + * `BYB` - Belarusian Ruble (1994–1999) - * `AFA` - Afghan Afghani (1927–2002) + * `BYR` - Belarusian Ruble (2000–2016) - * `ALL` - Albanian Lek + * `BEF` - Belgian Franc - * `ALK` - Albanian Lek (1946–1965) + * `BEC` - Belgian Franc (convertible) - * `DZD` - Algerian Dinar + * `BEL` - Belgian Franc (financial) - * `ADP` - Andorran Peseta + * `BZD` - Belize Dollar - * `AOA` - Angolan Kwanza + * `BMD` - Bermudan Dollar - * `AOK` - Angolan Kwanza (1977–1991) + * `BTN` - Bhutanese Ngultrum - * `AON` - Angolan New Kwanza (1990–2000) + * `BOB` - Bolivian Boliviano - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `BOL` - Bolivian Boliviano (1863–1963) - * `ARA` - Argentine Austral + * `BOV` - Bolivian Mvdol - * `ARS` - Argentine Peso + * `BOP` - Bolivian Peso - * `ARM` - Argentine Peso (1881–1970) + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `ARP` - Argentine Peso (1983–1985) + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `ARL` - Argentine Peso Ley (1970–1983) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `AMD` - Armenian Dram + * `BWP` - Botswanan Pula - * `AWG` - Aruban Florin + * `BRC` - Brazilian Cruzado (1986–1989) - * `AUD` - Australian Dollar + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `ATS` - Austrian Schilling + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `AZN` - Azerbaijani Manat + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `AZM` - Azerbaijani Manat (1993–2006) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BSD` - Bahamian Dollar + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BHD` - Bahraini Dinar + * `BRL` - Brazilian Real - * `BDT` - Bangladeshi Taka + * `GBP` - British Pound - * `BBD` - Barbadian Dollar + * `BND` - Brunei Dollar - * `BYN` - Belarusian Ruble + * `BGL` - Bulgarian Hard Lev - * `BYB` - Belarusian Ruble (1994–1999) + * `BGN` - Bulgarian Lev - * `BYR` - Belarusian Ruble (2000–2016) + * `BGO` - Bulgarian Lev (1879–1952) - * `BEF` - Belgian Franc + * `BGM` - Bulgarian Socialist Lev - * `BEC` - Belgian Franc (convertible) + * `BUK` - Burmese Kyat - * `BEL` - Belgian Franc (financial) + * `BIF` - Burundian Franc - * `BZD` - Belize Dollar + * `XPF` - CFP Franc - * `BMD` - Bermudan Dollar + * `KHR` - Cambodian Riel - * `BTN` - Bhutanese Ngultrum + * `CAD` - Canadian Dollar - * `BOB` - Bolivian Boliviano + * `CVE` - Cape Verdean Escudo - * `BOL` - Bolivian Boliviano (1863–1963) + * `KYD` - Cayman Islands Dollar - * `BOV` - Bolivian Mvdol + * `XAF` - Central African CFA Franc - * `BOP` - Bolivian Peso + * `CLE` - Chilean Escudo - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `CLP` - Chilean Peso - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `CLF` - Chilean Unit of Account (UF) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `CNX` - Chinese People’s Bank Dollar - * `BWP` - Botswanan Pula + * `CNY` - Chinese Yuan - * `BRC` - Brazilian Cruzado (1986–1989) + * `CNH` - Chinese Yuan (offshore) - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `COP` - Colombian Peso - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `COU` - Colombian Real Value Unit - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `KMF` - Comorian Franc - * `BRN` - Brazilian New Cruzado (1989–1990) + * `CDF` - Congolese Franc - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `CRC` - Costa Rican Colón - * `BRL` - Brazilian Real + * `HRD` - Croatian Dinar - * `GBP` - British Pound + * `HRK` - Croatian Kuna - * `BND` - Brunei Dollar + * `CUC` - Cuban Convertible Peso - * `BGL` - Bulgarian Hard Lev + * `CUP` - Cuban Peso - * `BGN` - Bulgarian Lev + * `CYP` - Cypriot Pound - * `BGO` - Bulgarian Lev (1879–1952) + * `CZK` - Czech Koruna - * `BGM` - Bulgarian Socialist Lev + * `CSK` - Czechoslovak Hard Koruna - * `BUK` - Burmese Kyat + * `DKK` - Danish Krone - * `BIF` - Burundian Franc + * `DJF` - Djiboutian Franc - * `XPF` - CFP Franc + * `DOP` - Dominican Peso - * `KHR` - Cambodian Riel + * `NLG` - Dutch Guilder - * `CAD` - Canadian Dollar + * `XCD` - East Caribbean Dollar - * `CVE` - Cape Verdean Escudo + * `DDM` - East German Mark - * `KYD` - Cayman Islands Dollar + * `ECS` - Ecuadorian Sucre - * `XAF` - Central African CFA Franc + * `ECV` - Ecuadorian Unit of Constant Value - * `CLE` - Chilean Escudo + * `EGP` - Egyptian Pound - * `CLP` - Chilean Peso + * `GQE` - Equatorial Guinean Ekwele - * `CLF` - Chilean Unit of Account (UF) + * `ERN` - Eritrean Nakfa - * `CNX` - Chinese People’s Bank Dollar + * `EEK` - Estonian Kroon - * `CNY` - Chinese Yuan + * `ETB` - Ethiopian Birr - * `CNH` - Chinese Yuan (offshore) + * `EUR` - Euro - * `COP` - Colombian Peso + * `XBA` - European Composite Unit - * `COU` - Colombian Real Value Unit + * `XEU` - European Currency Unit - * `KMF` - Comorian Franc + * `XBB` - European Monetary Unit - * `CDF` - Congolese Franc + * `XBC` - European Unit of Account (XBC) - * `CRC` - Costa Rican Colón + * `XBD` - European Unit of Account (XBD) - * `HRD` - Croatian Dinar + * `FKP` - Falkland Islands Pound - * `HRK` - Croatian Kuna + * `FJD` - Fijian Dollar - * `CUC` - Cuban Convertible Peso + * `FIM` - Finnish Markka - * `CUP` - Cuban Peso + * `FRF` - French Franc - * `CYP` - Cypriot Pound + * `XFO` - French Gold Franc - * `CZK` - Czech Koruna + * `XFU` - French UIC-Franc - * `CSK` - Czechoslovak Hard Koruna + * `GMD` - Gambian Dalasi - * `DKK` - Danish Krone + * `GEK` - Georgian Kupon Larit - * `DJF` - Djiboutian Franc + * `GEL` - Georgian Lari - * `DOP` - Dominican Peso + * `DEM` - German Mark - * `NLG` - Dutch Guilder + * `GHS` - Ghanaian Cedi - * `XCD` - East Caribbean Dollar + * `GHC` - Ghanaian Cedi (1979–2007) - * `DDM` - East German Mark + * `GIP` - Gibraltar Pound - * `ECS` - Ecuadorian Sucre + * `XAU` - Gold - * `ECV` - Ecuadorian Unit of Constant Value + * `GRD` - Greek Drachma - * `EGP` - Egyptian Pound + * `GTQ` - Guatemalan Quetzal - * `GQE` - Equatorial Guinean Ekwele + * `GWP` - Guinea-Bissau Peso - * `ERN` - Eritrean Nakfa + * `GNF` - Guinean Franc - * `EEK` - Estonian Kroon + * `GNS` - Guinean Syli - * `ETB` - Ethiopian Birr + * `GYD` - Guyanaese Dollar - * `EUR` - Euro + * `HTG` - Haitian Gourde - * `XBA` - European Composite Unit + * `HNL` - Honduran Lempira - * `XEU` - European Currency Unit + * `HKD` - Hong Kong Dollar - * `XBB` - European Monetary Unit + * `HUF` - Hungarian Forint - * `XBC` - European Unit of Account (XBC) + * `IMP` - IMP - * `XBD` - European Unit of Account (XBD) + * `ISK` - Icelandic Króna - * `FKP` - Falkland Islands Pound + * `ISJ` - Icelandic Króna (1918–1981) - * `FJD` - Fijian Dollar + * `INR` - Indian Rupee - * `FIM` - Finnish Markka + * `IDR` - Indonesian Rupiah - * `FRF` - French Franc + * `IRR` - Iranian Rial - * `XFO` - French Gold Franc + * `IQD` - Iraqi Dinar - * `XFU` - French UIC-Franc + * `IEP` - Irish Pound - * `GMD` - Gambian Dalasi + * `ILS` - Israeli New Shekel - * `GEK` - Georgian Kupon Larit + * `ILP` - Israeli Pound - * `GEL` - Georgian Lari + * `ILR` - Israeli Shekel (1980–1985) - * `DEM` - German Mark + * `ITL` - Italian Lira - * `GHS` - Ghanaian Cedi + * `JMD` - Jamaican Dollar - * `GHC` - Ghanaian Cedi (1979–2007) + * `JPY` - Japanese Yen - * `GIP` - Gibraltar Pound + * `JOD` - Jordanian Dinar - * `XAU` - Gold + * `KZT` - Kazakhstani Tenge - * `GRD` - Greek Drachma + * `KES` - Kenyan Shilling - * `GTQ` - Guatemalan Quetzal + * `KWD` - Kuwaiti Dinar - * `GWP` - Guinea-Bissau Peso + * `KGS` - Kyrgystani Som - * `GNF` - Guinean Franc + * `LAK` - Laotian Kip - * `GNS` - Guinean Syli + * `LVL` - Latvian Lats - * `GYD` - Guyanaese Dollar + * `LVR` - Latvian Ruble - * `HTG` - Haitian Gourde + * `LBP` - Lebanese Pound - * `HNL` - Honduran Lempira + * `LSL` - Lesotho Loti - * `HKD` - Hong Kong Dollar + * `LRD` - Liberian Dollar - * `HUF` - Hungarian Forint + * `LYD` - Libyan Dinar - * `IMP` - IMP + * `LTL` - Lithuanian Litas - * `ISK` - Icelandic Króna + * `LTT` - Lithuanian Talonas - * `ISJ` - Icelandic Króna (1918–1981) + * `LUL` - Luxembourg Financial Franc - * `INR` - Indian Rupee + * `LUC` - Luxembourgian Convertible Franc - * `IDR` - Indonesian Rupiah + * `LUF` - Luxembourgian Franc - * `IRR` - Iranian Rial + * `MOP` - Macanese Pataca - * `IQD` - Iraqi Dinar + * `MKD` - Macedonian Denar - * `IEP` - Irish Pound + * `MKN` - Macedonian Denar (1992–1993) - * `ILS` - Israeli New Shekel + * `MGA` - Malagasy Ariary - * `ILP` - Israeli Pound + * `MGF` - Malagasy Franc - * `ILR` - Israeli Shekel (1980–1985) + * `MWK` - Malawian Kwacha - * `ITL` - Italian Lira + * `MYR` - Malaysian Ringgit - * `JMD` - Jamaican Dollar + * `MVR` - Maldivian Rufiyaa - * `JPY` - Japanese Yen + * `MVP` - Maldivian Rupee (1947–1981) - * `JOD` - Jordanian Dinar + * `MLF` - Malian Franc - * `KZT` - Kazakhstani Tenge + * `MTL` - Maltese Lira - * `KES` - Kenyan Shilling + * `MTP` - Maltese Pound - * `KWD` - Kuwaiti Dinar + * `MRU` - Mauritanian Ouguiya - * `KGS` - Kyrgystani Som + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `LAK` - Laotian Kip + * `MUR` - Mauritian Rupee - * `LVL` - Latvian Lats + * `MXV` - Mexican Investment Unit - * `LVR` - Latvian Ruble + * `MXN` - Mexican Peso - * `LBP` - Lebanese Pound + * `MXP` - Mexican Silver Peso (1861–1992) - * `LSL` - Lesotho Loti + * `MDC` - Moldovan Cupon - * `LRD` - Liberian Dollar + * `MDL` - Moldovan Leu - * `LYD` - Libyan Dinar + * `MCF` - Monegasque Franc - * `LTL` - Lithuanian Litas + * `MNT` - Mongolian Tugrik - * `LTT` - Lithuanian Talonas + * `MAD` - Moroccan Dirham - * `LUL` - Luxembourg Financial Franc + * `MAF` - Moroccan Franc - * `LUC` - Luxembourgian Convertible Franc + * `MZE` - Mozambican Escudo - * `LUF` - Luxembourgian Franc + * `MZN` - Mozambican Metical - * `MOP` - Macanese Pataca + * `MZM` - Mozambican Metical (1980–2006) - * `MKD` - Macedonian Denar + * `MMK` - Myanmar Kyat - * `MKN` - Macedonian Denar (1992–1993) + * `NAD` - Namibian Dollar - * `MGA` - Malagasy Ariary + * `NPR` - Nepalese Rupee - * `MGF` - Malagasy Franc + * `ANG` - Netherlands Antillean Guilder - * `MWK` - Malawian Kwacha + * `TWD` - New Taiwan Dollar - * `MYR` - Malaysian Ringgit + * `NZD` - New Zealand Dollar - * `MVR` - Maldivian Rufiyaa + * `NIO` - Nicaraguan Córdoba - * `MVP` - Maldivian Rupee (1947–1981) + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `MLF` - Malian Franc + * `NGN` - Nigerian Naira - * `MTL` - Maltese Lira + * `KPW` - North Korean Won - * `MTP` - Maltese Pound + * `NOK` - Norwegian Krone - * `MRU` - Mauritanian Ouguiya + * `OMR` - Omani Rial - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `PKR` - Pakistani Rupee - * `MUR` - Mauritian Rupee + * `XPD` - Palladium - * `MXV` - Mexican Investment Unit + * `PAB` - Panamanian Balboa - * `MXN` - Mexican Peso + * `PGK` - Papua New Guinean Kina - * `MXP` - Mexican Silver Peso (1861–1992) + * `PYG` - Paraguayan Guarani - * `MDC` - Moldovan Cupon + * `PEI` - Peruvian Inti - * `MDL` - Moldovan Leu + * `PEN` - Peruvian Sol - * `MCF` - Monegasque Franc + * `PES` - Peruvian Sol (1863–1965) - * `MNT` - Mongolian Tugrik + * `PHP` - Philippine Peso - * `MAD` - Moroccan Dirham + * `XPT` - Platinum - * `MAF` - Moroccan Franc + * `PLN` - Polish Zloty - * `MZE` - Mozambican Escudo + * `PLZ` - Polish Zloty (1950–1995) - * `MZN` - Mozambican Metical + * `PTE` - Portuguese Escudo - * `MZM` - Mozambican Metical (1980–2006) + * `GWE` - Portuguese Guinea Escudo - * `MMK` - Myanmar Kyat + * `QAR` - Qatari Rial - * `NAD` - Namibian Dollar + * `XRE` - RINET Funds - * `NPR` - Nepalese Rupee + * `RHD` - Rhodesian Dollar - * `ANG` - Netherlands Antillean Guilder + * `RON` - Romanian Leu - * `TWD` - New Taiwan Dollar + * `ROL` - Romanian Leu (1952–2006) - * `NZD` - New Zealand Dollar + * `RUB` - Russian Ruble - * `NIO` - Nicaraguan Córdoba + * `RUR` - Russian Ruble (1991–1998) - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `RWF` - Rwandan Franc - * `NGN` - Nigerian Naira + * `SVC` - Salvadoran Colón - * `KPW` - North Korean Won + * `WST` - Samoan Tala - * `NOK` - Norwegian Krone + * `SAR` - Saudi Riyal - * `OMR` - Omani Rial + * `RSD` - Serbian Dinar - * `PKR` - Pakistani Rupee + * `CSD` - Serbian Dinar (2002–2006) - * `XPD` - Palladium + * `SCR` - Seychellois Rupee - * `PAB` - Panamanian Balboa + * `SLL` - Sierra Leonean Leone - * `PGK` - Papua New Guinean Kina + * `XAG` - Silver - * `PYG` - Paraguayan Guarani + * `SGD` - Singapore Dollar - * `PEI` - Peruvian Inti + * `SKK` - Slovak Koruna - * `PEN` - Peruvian Sol + * `SIT` - Slovenian Tolar - * `PES` - Peruvian Sol (1863–1965) + * `SBD` - Solomon Islands Dollar - * `PHP` - Philippine Peso + * `SOS` - Somali Shilling - * `XPT` - Platinum + * `ZAR` - South African Rand - * `PLN` - Polish Zloty + * `ZAL` - South African Rand (financial) - * `PLZ` - Polish Zloty (1950–1995) + * `KRH` - South Korean Hwan (1953–1962) - * `PTE` - Portuguese Escudo + * `KRW` - South Korean Won - * `GWE` - Portuguese Guinea Escudo + * `KRO` - South Korean Won (1945–1953) - * `QAR` - Qatari Rial + * `SSP` - South Sudanese Pound - * `XRE` - RINET Funds + * `SUR` - Soviet Rouble - * `RHD` - Rhodesian Dollar + * `ESP` - Spanish Peseta - * `RON` - Romanian Leu + * `ESA` - Spanish Peseta (A account) - * `ROL` - Romanian Leu (1952–2006) + * `ESB` - Spanish Peseta (convertible account) - * `RUB` - Russian Ruble + * `XDR` - Special Drawing Rights - * `RUR` - Russian Ruble (1991–1998) + * `LKR` - Sri Lankan Rupee - * `RWF` - Rwandan Franc + * `SHP` - St. Helena Pound - * `SVC` - Salvadoran Colón + * `XSU` - Sucre - * `WST` - Samoan Tala + * `SDD` - Sudanese Dinar (1992–2007) - * `SAR` - Saudi Riyal + * `SDG` - Sudanese Pound - * `RSD` - Serbian Dinar + * `SDP` - Sudanese Pound (1957–1998) - * `CSD` - Serbian Dinar (2002–2006) + * `SRD` - Surinamese Dollar - * `SCR` - Seychellois Rupee + * `SRG` - Surinamese Guilder - * `SLL` - Sierra Leonean Leone + * `SZL` - Swazi Lilangeni - * `XAG` - Silver + * `SEK` - Swedish Krona - * `SGD` - Singapore Dollar + * `CHF` - Swiss Franc - * `SKK` - Slovak Koruna + * `SYP` - Syrian Pound - * `SIT` - Slovenian Tolar + * `STN` - São Tomé & Príncipe Dobra - * `SBD` - Solomon Islands Dollar + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `SOS` - Somali Shilling + * `TVD` - TVD - * `ZAR` - South African Rand + * `TJR` - Tajikistani Ruble - * `ZAL` - South African Rand (financial) + * `TJS` - Tajikistani Somoni - * `KRH` - South Korean Hwan (1953–1962) + * `TZS` - Tanzanian Shilling - * `KRW` - South Korean Won + * `XTS` - Testing Currency Code - * `KRO` - South Korean Won (1945–1953) + * `THB` - Thai Baht - * `SSP` - South Sudanese Pound + * `XXX` - The codes assigned for transactions where no currency is + involved - * `SUR` - Soviet Rouble + * `TPE` - Timorese Escudo - * `ESP` - Spanish Peseta + * `TOP` - Tongan Paʻanga - * `ESA` - Spanish Peseta (A account) + * `TTD` - Trinidad & Tobago Dollar - * `ESB` - Spanish Peseta (convertible account) + * `TND` - Tunisian Dinar - * `XDR` - Special Drawing Rights + * `TRY` - Turkish Lira - * `LKR` - Sri Lankan Rupee + * `TRL` - Turkish Lira (1922–2005) - * `SHP` - St. Helena Pound + * `TMT` - Turkmenistani Manat - * `XSU` - Sucre + * `TMM` - Turkmenistani Manat (1993–2009) - * `SDD` - Sudanese Dinar (1992–2007) + * `USD` - US Dollar - * `SDG` - Sudanese Pound + * `USN` - US Dollar (Next day) - * `SDP` - Sudanese Pound (1957–1998) + * `USS` - US Dollar (Same day) - * `SRD` - Surinamese Dollar + * `UGX` - Ugandan Shilling - * `SRG` - Surinamese Guilder + * `UGS` - Ugandan Shilling (1966–1987) - * `SZL` - Swazi Lilangeni + * `UAH` - Ukrainian Hryvnia - * `SEK` - Swedish Krona + * `UAK` - Ukrainian Karbovanets - * `CHF` - Swiss Franc + * `AED` - United Arab Emirates Dirham - * `SYP` - Syrian Pound + * `UYW` - Uruguayan Nominal Wage Index Unit - * `STN` - São Tomé & Príncipe Dobra + * `UYU` - Uruguayan Peso - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `UYP` - Uruguayan Peso (1975–1993) - * `TVD` - TVD + * `UYI` - Uruguayan Peso (Indexed Units) - * `TJR` - Tajikistani Ruble + * `UZS` - Uzbekistani Som - * `TJS` - Tajikistani Somoni + * `VUV` - Vanuatu Vatu - * `TZS` - Tanzanian Shilling + * `VES` - Venezuelan Bolívar - * `XTS` - Testing Currency Code + * `VEB` - Venezuelan Bolívar (1871–2008) - * `THB` - Thai Baht + * `VEF` - Venezuelan Bolívar (2008–2018) - * `XXX` - The codes assigned for transactions where no currency is - involved + * `VND` - Vietnamese Dong - * `TPE` - Timorese Escudo + * `VNN` - Vietnamese Dong (1978–1985) - * `TOP` - Tongan Paʻanga + * `CHE` - WIR Euro - * `TTD` - Trinidad & Tobago Dollar + * `CHW` - WIR Franc - * `TND` - Tunisian Dinar + * `XOF` - West African CFA Franc - * `TRY` - Turkish Lira + * `YDD` - Yemeni Dinar - * `TRL` - Turkish Lira (1922–2005) + * `YER` - Yemeni Rial - * `TMT` - Turkmenistani Manat + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `TMM` - Turkmenistani Manat (1993–2009) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `USD` - US Dollar + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `USN` - US Dollar (Next day) + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `USS` - US Dollar (Same day) + * `ZWN` - ZWN - * `UGX` - Ugandan Shilling + * `ZRN` - Zairean New Zaire (1993–1998) - * `UGS` - Ugandan Shilling (1966–1987) + * `ZRZ` - Zairean Zaire (1971–1993) - * `UAH` - Ukrainian Hryvnia + * `ZMW` - Zambian Kwacha - * `UAK` - Ukrainian Karbovanets + * `ZMK` - Zambian Kwacha (1968–2012) - * `AED` - United Arab Emirates Dirham + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `UYW` - Uruguayan Nominal Wage Index Unit + * `ZWR` - Zimbabwean Dollar (2008) - * `UYU` - Uruguayan Peso + * `ZWL` - Zimbabwean Dollar (2009) + remote_created_at: + type: optional + docs: When the third party's credit note was created. + remote_updated_at: + type: optional + docs: When the third party's credit note was updated. + payments: + type: optional>> + docs: Array of `Payment` object IDs + applied_payments: + type: optional>> + docs: >- + A list of the Payment Applied to Lines common models related to a + given Invoice, Credit Note, or Journal Entry. + accounting_period: + type: optional + docs: The accounting period that the CreditNote was generated in. + applied_to_lines: + type: optional> + docs: >- + A list of the CreditNote Applied to Lines common models related to a + given Credit Note + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + CreditNoteApplyLineForCreditNoteInvoice: + discriminated: false + union: + - type: string + validation: + format: uuid + - Invoice + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteApplyLineForCreditNote: + docs: >- + # The CreditNoteApplyLine Object - * `UYP` - Uruguayan Peso (1975–1993) + ### Description - * `UYI` - Uruguayan Peso (Indexed Units) + The `CreditNoteApplyLine` is attached to the CreditNote model. - * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu + ### Usage Example - * `VES` - Venezuelan Bolívar + Fetch from the `GET CreditNote` endpoint and view the invoice's applied to + lines. + properties: + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + invoice: optional + applied_date: + type: optional + docs: Date that the credit note is applied to the invoice. + applied_amount: + type: optional + docs: The amount of the Credit Note applied to the invoice. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + source: + openapi: openapi/openapi.yml + CreditNoteApplyLineForCreditNoteRequestInvoice: + discriminated: false + union: + - type: string + validation: + format: uuid + - Invoice + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteApplyLineForCreditNoteRequest: + docs: >- + # The CreditNoteApplyLine Object - * `VEB` - Venezuelan Bolívar (1871–2008) + ### Description - * `VEF` - Venezuelan Bolívar (2008–2018) + The `CreditNoteApplyLine` is attached to the CreditNote model. - * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) + ### Usage Example - * `CHE` - WIR Euro + Fetch from the `GET CreditNote` endpoint and view the invoice's applied to + lines. + properties: + remote_id: + type: optional + docs: The third-party API ID of the matching object. + invoice: optional + applied_date: + type: optional + docs: Date that the credit note is applied to the invoice. + applied_amount: + type: optional + docs: The amount of the Credit Note applied to the invoice. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + CreditNoteApplyLineForInvoiceCreditNote: + discriminated: false + union: + - type: string + validation: + format: uuid + - CreditNote + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteApplyLineForInvoice: + docs: >- + # The CreditNoteApplyLine Object - * `CHW` - WIR Franc + ### Description - * `XOF` - West African CFA Franc + The `CreditNoteApplyLine` is attached to the CreditNote model. - * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial + ### Usage Example - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + Fetch from the `GET CreditNote` endpoint and view the invoice's applied to + lines. + properties: + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + credit_note: optional + applied_date: + type: optional + docs: Date that the credit note is applied to the invoice. + applied_amount: + type: optional + docs: The amount of the Credit Note applied to the invoice. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + source: + openapi: openapi/openapi.yml + CreditNoteLineItemItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - Item + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteLineItemCompany: + discriminated: false + docs: The company the credit note belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteLineItemContact: + discriminated: false + docs: The credit note's contact. + union: + - type: string + validation: + format: uuid + - Contact + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteLineItemProject: + discriminated: false + union: + - type: string + validation: + format: uuid + - Project + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteLineItem: + docs: >- + # The CreditNoteLineItem Object - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + ### Description - * `YUM` - Yugoslavian New Dinar (1994–2002) + The `CreditNoteLineItem` object is used to represent a credit note's line + items. - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN + ### Usage Example - * `ZRN` - Zairean New Zaire (1993–1998) + Fetch from the `GET CreditNote` endpoint and view the credit note's line + items. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + item: optional + name: + type: optional + docs: The credit note line item's name. + description: + type: optional + docs: The description of the item that is owed. + quantity: + type: optional + docs: The credit note line item's quantity. + validation: + pattern: ^-?\d{0,24}(?:\.\d{0,8})?$ + memo: + type: optional + docs: The credit note line item's memo. + unit_price: + type: optional + docs: The credit note line item's unit price. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + tax_rate: + type: optional + docs: The tax rate that applies to this line item. + validation: + format: uuid + total_line_amount: + type: optional + docs: The credit note line item's total. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + tracking_category: + type: optional + docs: The credit note line item's associated tracking category. + validation: + format: uuid + availability: deprecated + tracking_categories: + type: optional>> + docs: The credit note line item's associated tracking categories. + account: + type: optional + docs: The credit note line item's account. + validation: + format: uuid + company: + type: optional + docs: The company the credit note belongs to. + contact: + type: optional + docs: The credit note's contact. + project: optional + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + source: + openapi: openapi/openapi.yml + CreditNoteLineItemRequestItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - Item + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteLineItemRequestCompany: + discriminated: false + docs: The company the credit note belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteLineItemRequestContact: + discriminated: false + docs: The credit note's contact. + union: + - type: string + validation: + format: uuid + - Contact + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteLineItemRequestProject: + discriminated: false + union: + - type: string + validation: + format: uuid + - Project + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteLineItemRequest: + docs: >- + # The CreditNoteLineItem Object - * `ZRZ` - Zairean Zaire (1971–1993) + ### Description - * `ZMW` - Zambian Kwacha + The `CreditNoteLineItem` object is used to represent a credit note's line + items. - * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) + ### Usage Example - * `ZWR` - Zimbabwean Dollar (2008) + Fetch from the `GET CreditNote` endpoint and view the credit note's line + items. + properties: + remote_id: + type: optional + docs: The third-party API ID of the matching object. + item: optional + name: + type: optional + docs: The credit note line item's name. + description: + type: optional + docs: The description of the item that is owed. + quantity: + type: optional + docs: The credit note line item's quantity. + validation: + pattern: ^-?\d{0,24}(?:\.\d{0,8})?$ + memo: + type: optional + docs: The credit note line item's memo. + unit_price: + type: optional + docs: The credit note line item's unit price. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + tax_rate: + type: optional + docs: The tax rate that applies to this line item. + validation: + format: uuid + total_line_amount: + type: optional + docs: The credit note line item's total. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + tracking_category: + type: optional + docs: The credit note line item's associated tracking category. + validation: + format: uuid + availability: deprecated + tracking_categories: + type: optional>> + docs: The credit note line item's associated tracking categories. + account: + type: optional + docs: The credit note line item's account. + validation: + format: uuid + company: + type: optional + docs: The company the credit note belongs to. + contact: + type: optional + docs: The credit note's contact. + project: optional + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + CreditNoteRequestStatus: + discriminated: false + docs: |- + The credit note's status. - * `ZWL` - Zimbabwean Dollar (2009) + * `SUBMITTED` - SUBMITTED + * `AUTHORIZED` - AUTHORIZED + * `PAID` - PAID union: - - TransactionCurrencyEnum + - CreditNoteStatusEnum - string source: openapi: openapi/openapi.yml inline: true - ExpenseCompany: + CreditNoteRequestContact: discriminated: false - docs: The company the expense belongs to. + docs: The credit note's contact. union: - type: string validation: format: uuid - - CompanyInfo + - Contact source: openapi: openapi/openapi.yml inline: true - ExpenseEmployee: + CreditNoteRequestCompany: discriminated: false - docs: The employee this overall transaction relates to. + docs: The company the credit note belongs to. union: - type: string validation: format: uuid - - Employee + - CompanyInfo source: openapi: openapi/openapi.yml inline: true - ExpenseTrackingCategoriesItem: + CreditNoteRequestLineItemsItem: discriminated: false union: - type: string validation: format: uuid - - TrackingCategory + - CreditNoteLineItemRequest source: openapi: openapi/openapi.yml inline: true - ExpenseAccountingPeriod: + CreditNoteRequestTrackingCategoriesItem: discriminated: false - docs: The accounting period that the Expense was generated in. union: - type: string validation: format: uuid - - AccountingPeriod + - TrackingCategory source: openapi: openapi/openapi.yml inline: true - Expense: + CreditNoteRequestCurrency: + discriminated: false docs: >- - # The Expense Object + The credit note's currency. + + + * `XUA` - ADB Unit of Account + + * `AFN` - Afghan Afghani + + * `AFA` - Afghan Afghani (1927–2002) + + * `ALL` - Albanian Lek + + * `ALK` - Albanian Lek (1946–1965) + + * `DZD` - Algerian Dinar + + * `ADP` - Andorran Peseta + + * `AOA` - Angolan Kwanza + + * `AOK` - Angolan Kwanza (1977–1991) + + * `AON` - Angolan New Kwanza (1990–2000) + + * `AOR` - Angolan Readjusted Kwanza (1995–1999) + + * `ARA` - Argentine Austral + + * `ARS` - Argentine Peso + + * `ARM` - Argentine Peso (1881–1970) + + * `ARP` - Argentine Peso (1983–1985) + + * `ARL` - Argentine Peso Ley (1970–1983) + + * `AMD` - Armenian Dram + + * `AWG` - Aruban Florin + + * `AUD` - Australian Dollar + + * `ATS` - Austrian Schilling + + * `AZN` - Azerbaijani Manat + + * `AZM` - Azerbaijani Manat (1993–2006) + + * `BSD` - Bahamian Dollar + + * `BHD` - Bahraini Dinar + + * `BDT` - Bangladeshi Taka + + * `BBD` - Barbadian Dollar + + * `BYN` - Belarusian Ruble + + * `BYB` - Belarusian Ruble (1994–1999) + + * `BYR` - Belarusian Ruble (2000–2016) - ### Description + * `BEF` - Belgian Franc - The `Expense` object is used to represent a direct purchase by a business, - typically made with a check, credit card, or cash. Each `Expense` object - is dedicated to a grouping of expenses, with each expense recorded in the - lines object. + * `BEC` - Belgian Franc (convertible) + * `BEL` - Belgian Franc (financial) - The `Expense` object is used also used to represent refunds to direct - purchases. Refunds can be distinguished from purchases by the amount sign - of the records. Expense objects with a negative amount are purchases and - `Expense` objects with a positive amount are refunds to those purchases. + * `BZD` - Belize Dollar + * `BMD` - Bermudan Dollar - ### Usage Example + * `BTN` - Bhutanese Ngultrum - Fetch from the `GET Expense` endpoint and view a company's expense. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - transaction_date: - type: optional - docs: When the transaction occurred. - remote_created_at: - type: optional - docs: When the expense was created. - account: - type: optional - docs: The expense's payment account. - contact: - type: optional - docs: The expense's contact. - total_amount: - type: optional - docs: The expense's total amount. - sub_total: - type: optional - docs: The expense's total amount before tax. - total_tax_amount: - type: optional - docs: The expense's total tax amount. - currency: - type: optional - docs: >- - The expense's currency. + * `BOB` - Bolivian Boliviano + * `BOL` - Bolivian Boliviano (1863–1963) - * `XUA` - ADB Unit of Account + * `BOV` - Bolivian Mvdol - * `AFN` - Afghan Afghani + * `BOP` - Bolivian Peso - * `AFA` - Afghan Afghani (1927–2002) + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `ALL` - Albanian Lek + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `ALK` - Albanian Lek (1946–1965) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `DZD` - Algerian Dinar + * `BWP` - Botswanan Pula - * `ADP` - Andorran Peseta + * `BRC` - Brazilian Cruzado (1986–1989) - * `AOA` - Angolan Kwanza + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `AOK` - Angolan Kwanza (1977–1991) + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `AON` - Angolan New Kwanza (1990–2000) + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `ARA` - Argentine Austral + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `ARS` - Argentine Peso + * `BRL` - Brazilian Real - * `ARM` - Argentine Peso (1881–1970) + * `GBP` - British Pound - * `ARP` - Argentine Peso (1983–1985) + * `BND` - Brunei Dollar - * `ARL` - Argentine Peso Ley (1970–1983) + * `BGL` - Bulgarian Hard Lev - * `AMD` - Armenian Dram + * `BGN` - Bulgarian Lev - * `AWG` - Aruban Florin + * `BGO` - Bulgarian Lev (1879–1952) - * `AUD` - Australian Dollar + * `BGM` - Bulgarian Socialist Lev - * `ATS` - Austrian Schilling + * `BUK` - Burmese Kyat - * `AZN` - Azerbaijani Manat + * `BIF` - Burundian Franc - * `AZM` - Azerbaijani Manat (1993–2006) + * `XPF` - CFP Franc - * `BSD` - Bahamian Dollar + * `KHR` - Cambodian Riel - * `BHD` - Bahraini Dinar + * `CAD` - Canadian Dollar - * `BDT` - Bangladeshi Taka + * `CVE` - Cape Verdean Escudo - * `BBD` - Barbadian Dollar + * `KYD` - Cayman Islands Dollar - * `BYN` - Belarusian Ruble + * `XAF` - Central African CFA Franc - * `BYB` - Belarusian Ruble (1994–1999) + * `CLE` - Chilean Escudo - * `BYR` - Belarusian Ruble (2000–2016) + * `CLP` - Chilean Peso - * `BEF` - Belgian Franc + * `CLF` - Chilean Unit of Account (UF) - * `BEC` - Belgian Franc (convertible) + * `CNX` - Chinese People’s Bank Dollar - * `BEL` - Belgian Franc (financial) + * `CNY` - Chinese Yuan - * `BZD` - Belize Dollar + * `CNH` - Chinese Yuan (offshore) - * `BMD` - Bermudan Dollar + * `COP` - Colombian Peso - * `BTN` - Bhutanese Ngultrum + * `COU` - Colombian Real Value Unit - * `BOB` - Bolivian Boliviano + * `KMF` - Comorian Franc - * `BOL` - Bolivian Boliviano (1863–1963) + * `CDF` - Congolese Franc - * `BOV` - Bolivian Mvdol + * `CRC` - Costa Rican Colón - * `BOP` - Bolivian Peso + * `HRD` - Croatian Dinar - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `HRK` - Croatian Kuna - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `CUC` - Cuban Convertible Peso - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `CUP` - Cuban Peso - * `BWP` - Botswanan Pula + * `CYP` - Cypriot Pound - * `BRC` - Brazilian Cruzado (1986–1989) + * `CZK` - Czech Koruna - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `CSK` - Czechoslovak Hard Koruna - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `DKK` - Danish Krone - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `DJF` - Djiboutian Franc - * `BRN` - Brazilian New Cruzado (1989–1990) + * `DOP` - Dominican Peso - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `NLG` - Dutch Guilder - * `BRL` - Brazilian Real + * `XCD` - East Caribbean Dollar - * `GBP` - British Pound + * `DDM` - East German Mark - * `BND` - Brunei Dollar + * `ECS` - Ecuadorian Sucre - * `BGL` - Bulgarian Hard Lev + * `ECV` - Ecuadorian Unit of Constant Value - * `BGN` - Bulgarian Lev + * `EGP` - Egyptian Pound - * `BGO` - Bulgarian Lev (1879–1952) + * `GQE` - Equatorial Guinean Ekwele - * `BGM` - Bulgarian Socialist Lev + * `ERN` - Eritrean Nakfa - * `BUK` - Burmese Kyat + * `EEK` - Estonian Kroon - * `BIF` - Burundian Franc + * `ETB` - Ethiopian Birr - * `XPF` - CFP Franc + * `EUR` - Euro - * `KHR` - Cambodian Riel + * `XBA` - European Composite Unit - * `CAD` - Canadian Dollar + * `XEU` - European Currency Unit - * `CVE` - Cape Verdean Escudo + * `XBB` - European Monetary Unit - * `KYD` - Cayman Islands Dollar + * `XBC` - European Unit of Account (XBC) - * `XAF` - Central African CFA Franc + * `XBD` - European Unit of Account (XBD) - * `CLE` - Chilean Escudo + * `FKP` - Falkland Islands Pound - * `CLP` - Chilean Peso + * `FJD` - Fijian Dollar - * `CLF` - Chilean Unit of Account (UF) + * `FIM` - Finnish Markka - * `CNX` - Chinese People’s Bank Dollar + * `FRF` - French Franc - * `CNY` - Chinese Yuan + * `XFO` - French Gold Franc - * `CNH` - Chinese Yuan (offshore) + * `XFU` - French UIC-Franc - * `COP` - Colombian Peso + * `GMD` - Gambian Dalasi - * `COU` - Colombian Real Value Unit + * `GEK` - Georgian Kupon Larit - * `KMF` - Comorian Franc + * `GEL` - Georgian Lari - * `CDF` - Congolese Franc + * `DEM` - German Mark - * `CRC` - Costa Rican Colón + * `GHS` - Ghanaian Cedi - * `HRD` - Croatian Dinar + * `GHC` - Ghanaian Cedi (1979–2007) - * `HRK` - Croatian Kuna + * `GIP` - Gibraltar Pound - * `CUC` - Cuban Convertible Peso + * `XAU` - Gold - * `CUP` - Cuban Peso + * `GRD` - Greek Drachma - * `CYP` - Cypriot Pound + * `GTQ` - Guatemalan Quetzal - * `CZK` - Czech Koruna + * `GWP` - Guinea-Bissau Peso - * `CSK` - Czechoslovak Hard Koruna + * `GNF` - Guinean Franc - * `DKK` - Danish Krone + * `GNS` - Guinean Syli - * `DJF` - Djiboutian Franc + * `GYD` - Guyanaese Dollar - * `DOP` - Dominican Peso + * `HTG` - Haitian Gourde - * `NLG` - Dutch Guilder + * `HNL` - Honduran Lempira - * `XCD` - East Caribbean Dollar + * `HKD` - Hong Kong Dollar - * `DDM` - East German Mark + * `HUF` - Hungarian Forint - * `ECS` - Ecuadorian Sucre + * `IMP` - IMP - * `ECV` - Ecuadorian Unit of Constant Value + * `ISK` - Icelandic Króna - * `EGP` - Egyptian Pound + * `ISJ` - Icelandic Króna (1918–1981) - * `GQE` - Equatorial Guinean Ekwele + * `INR` - Indian Rupee - * `ERN` - Eritrean Nakfa + * `IDR` - Indonesian Rupiah - * `EEK` - Estonian Kroon + * `IRR` - Iranian Rial - * `ETB` - Ethiopian Birr + * `IQD` - Iraqi Dinar - * `EUR` - Euro + * `IEP` - Irish Pound - * `XBA` - European Composite Unit + * `ILS` - Israeli New Shekel - * `XEU` - European Currency Unit + * `ILP` - Israeli Pound - * `XBB` - European Monetary Unit + * `ILR` - Israeli Shekel (1980–1985) - * `XBC` - European Unit of Account (XBC) + * `ITL` - Italian Lira - * `XBD` - European Unit of Account (XBD) + * `JMD` - Jamaican Dollar - * `FKP` - Falkland Islands Pound + * `JPY` - Japanese Yen - * `FJD` - Fijian Dollar + * `JOD` - Jordanian Dinar - * `FIM` - Finnish Markka + * `KZT` - Kazakhstani Tenge - * `FRF` - French Franc + * `KES` - Kenyan Shilling - * `XFO` - French Gold Franc + * `KWD` - Kuwaiti Dinar - * `XFU` - French UIC-Franc + * `KGS` - Kyrgystani Som - * `GMD` - Gambian Dalasi + * `LAK` - Laotian Kip - * `GEK` - Georgian Kupon Larit + * `LVL` - Latvian Lats - * `GEL` - Georgian Lari + * `LVR` - Latvian Ruble - * `DEM` - German Mark + * `LBP` - Lebanese Pound - * `GHS` - Ghanaian Cedi + * `LSL` - Lesotho Loti - * `GHC` - Ghanaian Cedi (1979–2007) + * `LRD` - Liberian Dollar - * `GIP` - Gibraltar Pound + * `LYD` - Libyan Dinar - * `XAU` - Gold + * `LTL` - Lithuanian Litas - * `GRD` - Greek Drachma + * `LTT` - Lithuanian Talonas - * `GTQ` - Guatemalan Quetzal + * `LUL` - Luxembourg Financial Franc - * `GWP` - Guinea-Bissau Peso + * `LUC` - Luxembourgian Convertible Franc - * `GNF` - Guinean Franc + * `LUF` - Luxembourgian Franc - * `GNS` - Guinean Syli + * `MOP` - Macanese Pataca - * `GYD` - Guyanaese Dollar + * `MKD` - Macedonian Denar - * `HTG` - Haitian Gourde + * `MKN` - Macedonian Denar (1992–1993) - * `HNL` - Honduran Lempira + * `MGA` - Malagasy Ariary - * `HKD` - Hong Kong Dollar + * `MGF` - Malagasy Franc - * `HUF` - Hungarian Forint + * `MWK` - Malawian Kwacha - * `IMP` - IMP + * `MYR` - Malaysian Ringgit - * `ISK` - Icelandic Króna + * `MVR` - Maldivian Rufiyaa - * `ISJ` - Icelandic Króna (1918–1981) + * `MVP` - Maldivian Rupee (1947–1981) - * `INR` - Indian Rupee + * `MLF` - Malian Franc - * `IDR` - Indonesian Rupiah + * `MTL` - Maltese Lira - * `IRR` - Iranian Rial + * `MTP` - Maltese Pound - * `IQD` - Iraqi Dinar + * `MRU` - Mauritanian Ouguiya - * `IEP` - Irish Pound + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `ILS` - Israeli New Shekel + * `MUR` - Mauritian Rupee - * `ILP` - Israeli Pound + * `MXV` - Mexican Investment Unit - * `ILR` - Israeli Shekel (1980–1985) + * `MXN` - Mexican Peso - * `ITL` - Italian Lira + * `MXP` - Mexican Silver Peso (1861–1992) - * `JMD` - Jamaican Dollar + * `MDC` - Moldovan Cupon - * `JPY` - Japanese Yen + * `MDL` - Moldovan Leu - * `JOD` - Jordanian Dinar + * `MCF` - Monegasque Franc - * `KZT` - Kazakhstani Tenge + * `MNT` - Mongolian Tugrik - * `KES` - Kenyan Shilling + * `MAD` - Moroccan Dirham - * `KWD` - Kuwaiti Dinar + * `MAF` - Moroccan Franc - * `KGS` - Kyrgystani Som + * `MZE` - Mozambican Escudo - * `LAK` - Laotian Kip + * `MZN` - Mozambican Metical - * `LVL` - Latvian Lats + * `MZM` - Mozambican Metical (1980–2006) - * `LVR` - Latvian Ruble + * `MMK` - Myanmar Kyat - * `LBP` - Lebanese Pound + * `NAD` - Namibian Dollar - * `LSL` - Lesotho Loti + * `NPR` - Nepalese Rupee - * `LRD` - Liberian Dollar + * `ANG` - Netherlands Antillean Guilder - * `LYD` - Libyan Dinar + * `TWD` - New Taiwan Dollar - * `LTL` - Lithuanian Litas + * `NZD` - New Zealand Dollar - * `LTT` - Lithuanian Talonas + * `NIO` - Nicaraguan Córdoba - * `LUL` - Luxembourg Financial Franc + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `LUC` - Luxembourgian Convertible Franc + * `NGN` - Nigerian Naira - * `LUF` - Luxembourgian Franc + * `KPW` - North Korean Won - * `MOP` - Macanese Pataca + * `NOK` - Norwegian Krone - * `MKD` - Macedonian Denar + * `OMR` - Omani Rial - * `MKN` - Macedonian Denar (1992–1993) + * `PKR` - Pakistani Rupee - * `MGA` - Malagasy Ariary + * `XPD` - Palladium - * `MGF` - Malagasy Franc + * `PAB` - Panamanian Balboa - * `MWK` - Malawian Kwacha + * `PGK` - Papua New Guinean Kina - * `MYR` - Malaysian Ringgit + * `PYG` - Paraguayan Guarani - * `MVR` - Maldivian Rufiyaa + * `PEI` - Peruvian Inti - * `MVP` - Maldivian Rupee (1947–1981) + * `PEN` - Peruvian Sol - * `MLF` - Malian Franc + * `PES` - Peruvian Sol (1863–1965) - * `MTL` - Maltese Lira + * `PHP` - Philippine Peso - * `MTP` - Maltese Pound + * `XPT` - Platinum - * `MRU` - Mauritanian Ouguiya + * `PLN` - Polish Zloty - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `PLZ` - Polish Zloty (1950–1995) - * `MUR` - Mauritian Rupee + * `PTE` - Portuguese Escudo - * `MXV` - Mexican Investment Unit + * `GWE` - Portuguese Guinea Escudo - * `MXN` - Mexican Peso + * `QAR` - Qatari Rial - * `MXP` - Mexican Silver Peso (1861–1992) + * `XRE` - RINET Funds - * `MDC` - Moldovan Cupon + * `RHD` - Rhodesian Dollar - * `MDL` - Moldovan Leu + * `RON` - Romanian Leu - * `MCF` - Monegasque Franc + * `ROL` - Romanian Leu (1952–2006) - * `MNT` - Mongolian Tugrik + * `RUB` - Russian Ruble - * `MAD` - Moroccan Dirham + * `RUR` - Russian Ruble (1991–1998) - * `MAF` - Moroccan Franc + * `RWF` - Rwandan Franc - * `MZE` - Mozambican Escudo + * `SVC` - Salvadoran Colón - * `MZN` - Mozambican Metical + * `WST` - Samoan Tala - * `MZM` - Mozambican Metical (1980–2006) + * `SAR` - Saudi Riyal - * `MMK` - Myanmar Kyat + * `RSD` - Serbian Dinar - * `NAD` - Namibian Dollar + * `CSD` - Serbian Dinar (2002–2006) - * `NPR` - Nepalese Rupee + * `SCR` - Seychellois Rupee - * `ANG` - Netherlands Antillean Guilder + * `SLL` - Sierra Leonean Leone - * `TWD` - New Taiwan Dollar + * `XAG` - Silver - * `NZD` - New Zealand Dollar + * `SGD` - Singapore Dollar - * `NIO` - Nicaraguan Córdoba + * `SKK` - Slovak Koruna - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `SIT` - Slovenian Tolar - * `NGN` - Nigerian Naira + * `SBD` - Solomon Islands Dollar - * `KPW` - North Korean Won + * `SOS` - Somali Shilling - * `NOK` - Norwegian Krone + * `ZAR` - South African Rand - * `OMR` - Omani Rial + * `ZAL` - South African Rand (financial) - * `PKR` - Pakistani Rupee + * `KRH` - South Korean Hwan (1953–1962) - * `XPD` - Palladium + * `KRW` - South Korean Won - * `PAB` - Panamanian Balboa + * `KRO` - South Korean Won (1945–1953) - * `PGK` - Papua New Guinean Kina + * `SSP` - South Sudanese Pound - * `PYG` - Paraguayan Guarani + * `SUR` - Soviet Rouble + + * `ESP` - Spanish Peseta + + * `ESA` - Spanish Peseta (A account) + + * `ESB` - Spanish Peseta (convertible account) + + * `XDR` - Special Drawing Rights + + * `LKR` - Sri Lankan Rupee + + * `SHP` - St. Helena Pound + + * `XSU` - Sucre + + * `SDD` - Sudanese Dinar (1992–2007) + + * `SDG` - Sudanese Pound + + * `SDP` - Sudanese Pound (1957–1998) + + * `SRD` - Surinamese Dollar + + * `SRG` - Surinamese Guilder + + * `SZL` - Swazi Lilangeni + + * `SEK` - Swedish Krona + + * `CHF` - Swiss Franc + + * `SYP` - Syrian Pound + + * `STN` - São Tomé & Príncipe Dobra + + * `STD` - São Tomé & Príncipe Dobra (1977–2017) + + * `TVD` - TVD + + * `TJR` - Tajikistani Ruble + + * `TJS` - Tajikistani Somoni + + * `TZS` - Tanzanian Shilling + + * `XTS` - Testing Currency Code + + * `THB` - Thai Baht + + * `XXX` - The codes assigned for transactions where no currency is + involved - * `PEI` - Peruvian Inti + * `TPE` - Timorese Escudo - * `PEN` - Peruvian Sol + * `TOP` - Tongan Paʻanga - * `PES` - Peruvian Sol (1863–1965) + * `TTD` - Trinidad & Tobago Dollar - * `PHP` - Philippine Peso + * `TND` - Tunisian Dinar - * `XPT` - Platinum + * `TRY` - Turkish Lira - * `PLN` - Polish Zloty + * `TRL` - Turkish Lira (1922–2005) - * `PLZ` - Polish Zloty (1950–1995) + * `TMT` - Turkmenistani Manat - * `PTE` - Portuguese Escudo + * `TMM` - Turkmenistani Manat (1993–2009) - * `GWE` - Portuguese Guinea Escudo + * `USD` - US Dollar - * `QAR` - Qatari Rial + * `USN` - US Dollar (Next day) - * `XRE` - RINET Funds + * `USS` - US Dollar (Same day) - * `RHD` - Rhodesian Dollar + * `UGX` - Ugandan Shilling - * `RON` - Romanian Leu + * `UGS` - Ugandan Shilling (1966–1987) - * `ROL` - Romanian Leu (1952–2006) + * `UAH` - Ukrainian Hryvnia - * `RUB` - Russian Ruble + * `UAK` - Ukrainian Karbovanets - * `RUR` - Russian Ruble (1991–1998) + * `AED` - United Arab Emirates Dirham - * `RWF` - Rwandan Franc + * `UYW` - Uruguayan Nominal Wage Index Unit - * `SVC` - Salvadoran Colón + * `UYU` - Uruguayan Peso - * `WST` - Samoan Tala + * `UYP` - Uruguayan Peso (1975–1993) - * `SAR` - Saudi Riyal + * `UYI` - Uruguayan Peso (Indexed Units) - * `RSD` - Serbian Dinar + * `UZS` - Uzbekistani Som - * `CSD` - Serbian Dinar (2002–2006) + * `VUV` - Vanuatu Vatu - * `SCR` - Seychellois Rupee + * `VES` - Venezuelan Bolívar - * `SLL` - Sierra Leonean Leone + * `VEB` - Venezuelan Bolívar (1871–2008) - * `XAG` - Silver + * `VEF` - Venezuelan Bolívar (2008–2018) - * `SGD` - Singapore Dollar + * `VND` - Vietnamese Dong - * `SKK` - Slovak Koruna + * `VNN` - Vietnamese Dong (1978–1985) - * `SIT` - Slovenian Tolar + * `CHE` - WIR Euro - * `SBD` - Solomon Islands Dollar + * `CHW` - WIR Franc - * `SOS` - Somali Shilling + * `XOF` - West African CFA Franc - * `ZAR` - South African Rand + * `YDD` - Yemeni Dinar - * `ZAL` - South African Rand (financial) + * `YER` - Yemeni Rial - * `KRH` - South Korean Hwan (1953–1962) + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `KRW` - South Korean Won + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `KRO` - South Korean Won (1945–1953) + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `SSP` - South Sudanese Pound + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `SUR` - Soviet Rouble + * `ZWN` - ZWN - * `ESP` - Spanish Peseta + * `ZRN` - Zairean New Zaire (1993–1998) - * `ESA` - Spanish Peseta (A account) + * `ZRZ` - Zairean Zaire (1971–1993) - * `ESB` - Spanish Peseta (convertible account) + * `ZMW` - Zambian Kwacha - * `XDR` - Special Drawing Rights + * `ZMK` - Zambian Kwacha (1968–2012) - * `LKR` - Sri Lankan Rupee + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `SHP` - St. Helena Pound + * `ZWR` - Zimbabwean Dollar (2008) - * `XSU` - Sucre + * `ZWL` - Zimbabwean Dollar (2009) + union: + - TransactionCurrencyEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteRequestPaymentsItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - Payment + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteRequestAppliedPaymentsItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - PaymentLineItem + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteRequestAccountingPeriod: + discriminated: false + docs: The accounting period that the CreditNote was generated in. + union: + - type: string + validation: + format: uuid + - AccountingPeriod + source: + openapi: openapi/openapi.yml + inline: true + CreditNoteRequest: + docs: >- + # The CreditNote Object - * `SDD` - Sudanese Dinar (1992–2007) + ### Description - * `SDG` - Sudanese Pound + A `CreditNote` is transaction issued to a customer, indicating a reduction + or cancellation of the amount owed by the customer. It is most generally + used as an adjustment note used to rectify errors, returns, or + overpayments related to a sales transaction. A `CreditNote` can be applied + to *Accounts Receivable* Invoices to decrease the overall amount of the + Invoice. - * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar + ### Usage Example - * `SRG` - Surinamese Guilder + Fetch from the `LIST CreditNotes` endpoint and view a company's credit + notes. + properties: + transaction_date: + type: optional + docs: The credit note's transaction date. + status: + type: optional + docs: |- + The credit note's status. - * `SZL` - Swazi Lilangeni + * `SUBMITTED` - SUBMITTED + * `AUTHORIZED` - AUTHORIZED + * `PAID` - PAID + number: + type: optional + docs: The credit note's number. + contact: + type: optional + docs: The credit note's contact. + company: + type: optional + docs: The company the credit note belongs to. + exchange_rate: + type: optional + docs: The credit note's exchange rate. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + total_amount: + type: optional + docs: The credit note's total amount. + remaining_credit: + type: optional + docs: >- + The amount of value remaining in the credit note that the customer can + use. + inclusive_of_tax: + type: optional + docs: >- + If the transaction is inclusive or exclusive of tax. `True` if + inclusive, `False` if exclusive. + line_items: optional> + tracking_categories: optional>> + currency: + type: optional + docs: >- + The credit note's currency. - * `SEK` - Swedish Krona - * `CHF` - Swiss Franc + * `XUA` - ADB Unit of Account - * `SYP` - Syrian Pound + * `AFN` - Afghan Afghani - * `STN` - São Tomé & Príncipe Dobra + * `AFA` - Afghan Afghani (1927–2002) - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `ALL` - Albanian Lek - * `TVD` - TVD + * `ALK` - Albanian Lek (1946–1965) - * `TJR` - Tajikistani Ruble + * `DZD` - Algerian Dinar - * `TJS` - Tajikistani Somoni + * `ADP` - Andorran Peseta - * `TZS` - Tanzanian Shilling + * `AOA` - Angolan Kwanza - * `XTS` - Testing Currency Code + * `AOK` - Angolan Kwanza (1977–1991) - * `THB` - Thai Baht + * `AON` - Angolan New Kwanza (1990–2000) - * `XXX` - The codes assigned for transactions where no currency is - involved + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `TPE` - Timorese Escudo + * `ARA` - Argentine Austral - * `TOP` - Tongan Paʻanga + * `ARS` - Argentine Peso - * `TTD` - Trinidad & Tobago Dollar + * `ARM` - Argentine Peso (1881–1970) - * `TND` - Tunisian Dinar + * `ARP` - Argentine Peso (1983–1985) - * `TRY` - Turkish Lira + * `ARL` - Argentine Peso Ley (1970–1983) - * `TRL` - Turkish Lira (1922–2005) + * `AMD` - Armenian Dram - * `TMT` - Turkmenistani Manat + * `AWG` - Aruban Florin - * `TMM` - Turkmenistani Manat (1993–2009) + * `AUD` - Australian Dollar - * `USD` - US Dollar + * `ATS` - Austrian Schilling - * `USN` - US Dollar (Next day) + * `AZN` - Azerbaijani Manat - * `USS` - US Dollar (Same day) + * `AZM` - Azerbaijani Manat (1993–2006) - * `UGX` - Ugandan Shilling + * `BSD` - Bahamian Dollar - * `UGS` - Ugandan Shilling (1966–1987) + * `BHD` - Bahraini Dinar - * `UAH` - Ukrainian Hryvnia + * `BDT` - Bangladeshi Taka - * `UAK` - Ukrainian Karbovanets + * `BBD` - Barbadian Dollar - * `AED` - United Arab Emirates Dirham + * `BYN` - Belarusian Ruble - * `UYW` - Uruguayan Nominal Wage Index Unit + * `BYB` - Belarusian Ruble (1994–1999) - * `UYU` - Uruguayan Peso + * `BYR` - Belarusian Ruble (2000–2016) - * `UYP` - Uruguayan Peso (1975–1993) + * `BEF` - Belgian Franc - * `UYI` - Uruguayan Peso (Indexed Units) + * `BEC` - Belgian Franc (convertible) - * `UZS` - Uzbekistani Som + * `BEL` - Belgian Franc (financial) - * `VUV` - Vanuatu Vatu + * `BZD` - Belize Dollar - * `VES` - Venezuelan Bolívar + * `BMD` - Bermudan Dollar - * `VEB` - Venezuelan Bolívar (1871–2008) + * `BTN` - Bhutanese Ngultrum - * `VEF` - Venezuelan Bolívar (2008–2018) + * `BOB` - Bolivian Boliviano - * `VND` - Vietnamese Dong + * `BOL` - Bolivian Boliviano (1863–1963) - * `VNN` - Vietnamese Dong (1978–1985) + * `BOV` - Bolivian Mvdol - * `CHE` - WIR Euro + * `BOP` - Bolivian Peso - * `CHW` - WIR Franc + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `XOF` - West African CFA Franc + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `YDD` - Yemeni Dinar + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `YER` - Yemeni Rial + * `BWP` - Botswanan Pula - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `BRC` - Brazilian Cruzado (1986–1989) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `ZWN` - ZWN + * `BRN` - Brazilian New Cruzado (1989–1990) - * `ZRN` - Zairean New Zaire (1993–1998) + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `ZRZ` - Zairean Zaire (1971–1993) + * `BRL` - Brazilian Real - * `ZMW` - Zambian Kwacha + * `GBP` - British Pound - * `ZMK` - Zambian Kwacha (1968–2012) + * `BND` - Brunei Dollar - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `BGL` - Bulgarian Hard Lev - * `ZWR` - Zimbabwean Dollar (2008) + * `BGN` - Bulgarian Lev - * `ZWL` - Zimbabwean Dollar (2009) - exchange_rate: - type: optional - docs: The expense's exchange rate. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - inclusive_of_tax: - type: optional - docs: >- - If the transaction is inclusive or exclusive of tax. `True` if - inclusive, `False` if exclusive. - company: - type: optional - docs: The company the expense belongs to. - employee: - type: optional - docs: The employee this overall transaction relates to. - memo: - type: optional - docs: The expense's private note. - lines: optional> - tracking_categories: optional>> - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - accounting_period: - type: optional - docs: The accounting period that the Expense was generated in. - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - remote_fields: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - ExpenseLineItem: - discriminated: false - docs: The line's item. - union: - - type: string - validation: - format: uuid - - Item - source: - openapi: openapi/openapi.yml - inline: true - ExpenseLineTrackingCategory: - discriminated: false - union: - - type: string - validation: - format: uuid - - TrackingCategory - source: - openapi: openapi/openapi.yml - inline: true - ExpenseLineTrackingCategoriesItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - TrackingCategory - source: - openapi: openapi/openapi.yml - inline: true - ExpenseLineEmployee: - discriminated: false - docs: The employee this overall transaction relates to. - union: - - type: string - validation: - format: uuid - - Employee - source: - openapi: openapi/openapi.yml - inline: true - ExpenseLineCurrency: - discriminated: false - docs: >- - The expense line item's currency. + * `BGO` - Bulgarian Lev (1879–1952) + * `BGM` - Bulgarian Socialist Lev - * `XUA` - ADB Unit of Account + * `BUK` - Burmese Kyat - * `AFN` - Afghan Afghani + * `BIF` - Burundian Franc - * `AFA` - Afghan Afghani (1927–2002) + * `XPF` - CFP Franc - * `ALL` - Albanian Lek + * `KHR` - Cambodian Riel - * `ALK` - Albanian Lek (1946–1965) + * `CAD` - Canadian Dollar - * `DZD` - Algerian Dinar + * `CVE` - Cape Verdean Escudo - * `ADP` - Andorran Peseta + * `KYD` - Cayman Islands Dollar - * `AOA` - Angolan Kwanza + * `XAF` - Central African CFA Franc - * `AOK` - Angolan Kwanza (1977–1991) + * `CLE` - Chilean Escudo - * `AON` - Angolan New Kwanza (1990–2000) + * `CLP` - Chilean Peso - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `CLF` - Chilean Unit of Account (UF) - * `ARA` - Argentine Austral + * `CNX` - Chinese People’s Bank Dollar - * `ARS` - Argentine Peso + * `CNY` - Chinese Yuan - * `ARM` - Argentine Peso (1881–1970) + * `CNH` - Chinese Yuan (offshore) - * `ARP` - Argentine Peso (1983–1985) + * `COP` - Colombian Peso - * `ARL` - Argentine Peso Ley (1970–1983) + * `COU` - Colombian Real Value Unit - * `AMD` - Armenian Dram + * `KMF` - Comorian Franc - * `AWG` - Aruban Florin + * `CDF` - Congolese Franc - * `AUD` - Australian Dollar + * `CRC` - Costa Rican Colón - * `ATS` - Austrian Schilling + * `HRD` - Croatian Dinar - * `AZN` - Azerbaijani Manat + * `HRK` - Croatian Kuna - * `AZM` - Azerbaijani Manat (1993–2006) + * `CUC` - Cuban Convertible Peso - * `BSD` - Bahamian Dollar + * `CUP` - Cuban Peso - * `BHD` - Bahraini Dinar + * `CYP` - Cypriot Pound - * `BDT` - Bangladeshi Taka + * `CZK` - Czech Koruna - * `BBD` - Barbadian Dollar + * `CSK` - Czechoslovak Hard Koruna - * `BYN` - Belarusian Ruble + * `DKK` - Danish Krone - * `BYB` - Belarusian Ruble (1994–1999) + * `DJF` - Djiboutian Franc - * `BYR` - Belarusian Ruble (2000–2016) + * `DOP` - Dominican Peso - * `BEF` - Belgian Franc + * `NLG` - Dutch Guilder - * `BEC` - Belgian Franc (convertible) + * `XCD` - East Caribbean Dollar - * `BEL` - Belgian Franc (financial) + * `DDM` - East German Mark - * `BZD` - Belize Dollar + * `ECS` - Ecuadorian Sucre - * `BMD` - Bermudan Dollar + * `ECV` - Ecuadorian Unit of Constant Value - * `BTN` - Bhutanese Ngultrum + * `EGP` - Egyptian Pound - * `BOB` - Bolivian Boliviano + * `GQE` - Equatorial Guinean Ekwele - * `BOL` - Bolivian Boliviano (1863–1963) + * `ERN` - Eritrean Nakfa - * `BOV` - Bolivian Mvdol + * `EEK` - Estonian Kroon - * `BOP` - Bolivian Peso + * `ETB` - Ethiopian Birr - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `EUR` - Euro - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `XBA` - European Composite Unit - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `XEU` - European Currency Unit - * `BWP` - Botswanan Pula + * `XBB` - European Monetary Unit - * `BRC` - Brazilian Cruzado (1986–1989) + * `XBC` - European Unit of Account (XBC) - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `XBD` - European Unit of Account (XBD) - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `FKP` - Falkland Islands Pound - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `FJD` - Fijian Dollar - * `BRN` - Brazilian New Cruzado (1989–1990) + * `FIM` - Finnish Markka - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `FRF` - French Franc - * `BRL` - Brazilian Real + * `XFO` - French Gold Franc - * `GBP` - British Pound + * `XFU` - French UIC-Franc - * `BND` - Brunei Dollar + * `GMD` - Gambian Dalasi - * `BGL` - Bulgarian Hard Lev + * `GEK` - Georgian Kupon Larit - * `BGN` - Bulgarian Lev + * `GEL` - Georgian Lari - * `BGO` - Bulgarian Lev (1879–1952) + * `DEM` - German Mark - * `BGM` - Bulgarian Socialist Lev + * `GHS` - Ghanaian Cedi - * `BUK` - Burmese Kyat + * `GHC` - Ghanaian Cedi (1979–2007) - * `BIF` - Burundian Franc + * `GIP` - Gibraltar Pound - * `XPF` - CFP Franc + * `XAU` - Gold - * `KHR` - Cambodian Riel + * `GRD` - Greek Drachma - * `CAD` - Canadian Dollar + * `GTQ` - Guatemalan Quetzal - * `CVE` - Cape Verdean Escudo + * `GWP` - Guinea-Bissau Peso - * `KYD` - Cayman Islands Dollar + * `GNF` - Guinean Franc - * `XAF` - Central African CFA Franc + * `GNS` - Guinean Syli - * `CLE` - Chilean Escudo + * `GYD` - Guyanaese Dollar - * `CLP` - Chilean Peso + * `HTG` - Haitian Gourde - * `CLF` - Chilean Unit of Account (UF) + * `HNL` - Honduran Lempira - * `CNX` - Chinese People’s Bank Dollar + * `HKD` - Hong Kong Dollar - * `CNY` - Chinese Yuan + * `HUF` - Hungarian Forint - * `CNH` - Chinese Yuan (offshore) + * `IMP` - IMP - * `COP` - Colombian Peso + * `ISK` - Icelandic Króna - * `COU` - Colombian Real Value Unit + * `ISJ` - Icelandic Króna (1918–1981) - * `KMF` - Comorian Franc + * `INR` - Indian Rupee - * `CDF` - Congolese Franc + * `IDR` - Indonesian Rupiah - * `CRC` - Costa Rican Colón + * `IRR` - Iranian Rial - * `HRD` - Croatian Dinar + * `IQD` - Iraqi Dinar - * `HRK` - Croatian Kuna + * `IEP` - Irish Pound - * `CUC` - Cuban Convertible Peso + * `ILS` - Israeli New Shekel - * `CUP` - Cuban Peso + * `ILP` - Israeli Pound - * `CYP` - Cypriot Pound + * `ILR` - Israeli Shekel (1980–1985) - * `CZK` - Czech Koruna + * `ITL` - Italian Lira - * `CSK` - Czechoslovak Hard Koruna + * `JMD` - Jamaican Dollar - * `DKK` - Danish Krone + * `JPY` - Japanese Yen - * `DJF` - Djiboutian Franc + * `JOD` - Jordanian Dinar - * `DOP` - Dominican Peso + * `KZT` - Kazakhstani Tenge - * `NLG` - Dutch Guilder + * `KES` - Kenyan Shilling - * `XCD` - East Caribbean Dollar + * `KWD` - Kuwaiti Dinar - * `DDM` - East German Mark + * `KGS` - Kyrgystani Som - * `ECS` - Ecuadorian Sucre + * `LAK` - Laotian Kip - * `ECV` - Ecuadorian Unit of Constant Value + * `LVL` - Latvian Lats - * `EGP` - Egyptian Pound + * `LVR` - Latvian Ruble - * `GQE` - Equatorial Guinean Ekwele + * `LBP` - Lebanese Pound - * `ERN` - Eritrean Nakfa + * `LSL` - Lesotho Loti - * `EEK` - Estonian Kroon + * `LRD` - Liberian Dollar - * `ETB` - Ethiopian Birr + * `LYD` - Libyan Dinar - * `EUR` - Euro + * `LTL` - Lithuanian Litas - * `XBA` - European Composite Unit + * `LTT` - Lithuanian Talonas - * `XEU` - European Currency Unit + * `LUL` - Luxembourg Financial Franc - * `XBB` - European Monetary Unit + * `LUC` - Luxembourgian Convertible Franc - * `XBC` - European Unit of Account (XBC) + * `LUF` - Luxembourgian Franc - * `XBD` - European Unit of Account (XBD) + * `MOP` - Macanese Pataca - * `FKP` - Falkland Islands Pound + * `MKD` - Macedonian Denar - * `FJD` - Fijian Dollar + * `MKN` - Macedonian Denar (1992–1993) - * `FIM` - Finnish Markka + * `MGA` - Malagasy Ariary - * `FRF` - French Franc + * `MGF` - Malagasy Franc - * `XFO` - French Gold Franc + * `MWK` - Malawian Kwacha - * `XFU` - French UIC-Franc + * `MYR` - Malaysian Ringgit - * `GMD` - Gambian Dalasi + * `MVR` - Maldivian Rufiyaa - * `GEK` - Georgian Kupon Larit + * `MVP` - Maldivian Rupee (1947–1981) - * `GEL` - Georgian Lari + * `MLF` - Malian Franc - * `DEM` - German Mark + * `MTL` - Maltese Lira - * `GHS` - Ghanaian Cedi + * `MTP` - Maltese Pound - * `GHC` - Ghanaian Cedi (1979–2007) + * `MRU` - Mauritanian Ouguiya - * `GIP` - Gibraltar Pound + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `XAU` - Gold + * `MUR` - Mauritian Rupee - * `GRD` - Greek Drachma + * `MXV` - Mexican Investment Unit - * `GTQ` - Guatemalan Quetzal + * `MXN` - Mexican Peso - * `GWP` - Guinea-Bissau Peso + * `MXP` - Mexican Silver Peso (1861–1992) - * `GNF` - Guinean Franc + * `MDC` - Moldovan Cupon - * `GNS` - Guinean Syli + * `MDL` - Moldovan Leu - * `GYD` - Guyanaese Dollar + * `MCF` - Monegasque Franc - * `HTG` - Haitian Gourde + * `MNT` - Mongolian Tugrik - * `HNL` - Honduran Lempira + * `MAD` - Moroccan Dirham - * `HKD` - Hong Kong Dollar + * `MAF` - Moroccan Franc - * `HUF` - Hungarian Forint + * `MZE` - Mozambican Escudo - * `IMP` - IMP + * `MZN` - Mozambican Metical - * `ISK` - Icelandic Króna + * `MZM` - Mozambican Metical (1980–2006) - * `ISJ` - Icelandic Króna (1918–1981) + * `MMK` - Myanmar Kyat - * `INR` - Indian Rupee + * `NAD` - Namibian Dollar - * `IDR` - Indonesian Rupiah + * `NPR` - Nepalese Rupee - * `IRR` - Iranian Rial + * `ANG` - Netherlands Antillean Guilder - * `IQD` - Iraqi Dinar + * `TWD` - New Taiwan Dollar - * `IEP` - Irish Pound + * `NZD` - New Zealand Dollar - * `ILS` - Israeli New Shekel + * `NIO` - Nicaraguan Córdoba - * `ILP` - Israeli Pound + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `ILR` - Israeli Shekel (1980–1985) + * `NGN` - Nigerian Naira - * `ITL` - Italian Lira + * `KPW` - North Korean Won - * `JMD` - Jamaican Dollar + * `NOK` - Norwegian Krone - * `JPY` - Japanese Yen + * `OMR` - Omani Rial - * `JOD` - Jordanian Dinar + * `PKR` - Pakistani Rupee - * `KZT` - Kazakhstani Tenge + * `XPD` - Palladium - * `KES` - Kenyan Shilling + * `PAB` - Panamanian Balboa - * `KWD` - Kuwaiti Dinar + * `PGK` - Papua New Guinean Kina - * `KGS` - Kyrgystani Som + * `PYG` - Paraguayan Guarani - * `LAK` - Laotian Kip + * `PEI` - Peruvian Inti - * `LVL` - Latvian Lats + * `PEN` - Peruvian Sol - * `LVR` - Latvian Ruble + * `PES` - Peruvian Sol (1863–1965) - * `LBP` - Lebanese Pound + * `PHP` - Philippine Peso - * `LSL` - Lesotho Loti + * `XPT` - Platinum - * `LRD` - Liberian Dollar + * `PLN` - Polish Zloty - * `LYD` - Libyan Dinar + * `PLZ` - Polish Zloty (1950–1995) - * `LTL` - Lithuanian Litas + * `PTE` - Portuguese Escudo - * `LTT` - Lithuanian Talonas + * `GWE` - Portuguese Guinea Escudo - * `LUL` - Luxembourg Financial Franc + * `QAR` - Qatari Rial - * `LUC` - Luxembourgian Convertible Franc + * `XRE` - RINET Funds - * `LUF` - Luxembourgian Franc + * `RHD` - Rhodesian Dollar - * `MOP` - Macanese Pataca + * `RON` - Romanian Leu - * `MKD` - Macedonian Denar + * `ROL` - Romanian Leu (1952–2006) - * `MKN` - Macedonian Denar (1992–1993) + * `RUB` - Russian Ruble - * `MGA` - Malagasy Ariary + * `RUR` - Russian Ruble (1991–1998) - * `MGF` - Malagasy Franc + * `RWF` - Rwandan Franc - * `MWK` - Malawian Kwacha + * `SVC` - Salvadoran Colón - * `MYR` - Malaysian Ringgit + * `WST` - Samoan Tala - * `MVR` - Maldivian Rufiyaa + * `SAR` - Saudi Riyal - * `MVP` - Maldivian Rupee (1947–1981) + * `RSD` - Serbian Dinar - * `MLF` - Malian Franc + * `CSD` - Serbian Dinar (2002–2006) - * `MTL` - Maltese Lira + * `SCR` - Seychellois Rupee - * `MTP` - Maltese Pound + * `SLL` - Sierra Leonean Leone - * `MRU` - Mauritanian Ouguiya + * `XAG` - Silver - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `SGD` - Singapore Dollar - * `MUR` - Mauritian Rupee + * `SKK` - Slovak Koruna - * `MXV` - Mexican Investment Unit + * `SIT` - Slovenian Tolar - * `MXN` - Mexican Peso + * `SBD` - Solomon Islands Dollar - * `MXP` - Mexican Silver Peso (1861–1992) + * `SOS` - Somali Shilling - * `MDC` - Moldovan Cupon + * `ZAR` - South African Rand - * `MDL` - Moldovan Leu + * `ZAL` - South African Rand (financial) - * `MCF` - Monegasque Franc + * `KRH` - South Korean Hwan (1953–1962) - * `MNT` - Mongolian Tugrik + * `KRW` - South Korean Won - * `MAD` - Moroccan Dirham + * `KRO` - South Korean Won (1945–1953) - * `MAF` - Moroccan Franc + * `SSP` - South Sudanese Pound - * `MZE` - Mozambican Escudo + * `SUR` - Soviet Rouble - * `MZN` - Mozambican Metical + * `ESP` - Spanish Peseta - * `MZM` - Mozambican Metical (1980–2006) + * `ESA` - Spanish Peseta (A account) - * `MMK` - Myanmar Kyat + * `ESB` - Spanish Peseta (convertible account) - * `NAD` - Namibian Dollar + * `XDR` - Special Drawing Rights - * `NPR` - Nepalese Rupee + * `LKR` - Sri Lankan Rupee - * `ANG` - Netherlands Antillean Guilder + * `SHP` - St. Helena Pound - * `TWD` - New Taiwan Dollar + * `XSU` - Sucre - * `NZD` - New Zealand Dollar + * `SDD` - Sudanese Dinar (1992–2007) - * `NIO` - Nicaraguan Córdoba + * `SDG` - Sudanese Pound - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `SDP` - Sudanese Pound (1957–1998) - * `NGN` - Nigerian Naira + * `SRD` - Surinamese Dollar - * `KPW` - North Korean Won + * `SRG` - Surinamese Guilder - * `NOK` - Norwegian Krone + * `SZL` - Swazi Lilangeni - * `OMR` - Omani Rial + * `SEK` - Swedish Krona - * `PKR` - Pakistani Rupee + * `CHF` - Swiss Franc - * `XPD` - Palladium + * `SYP` - Syrian Pound - * `PAB` - Panamanian Balboa + * `STN` - São Tomé & Príncipe Dobra - * `PGK` - Papua New Guinean Kina + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `PYG` - Paraguayan Guarani + * `TVD` - TVD - * `PEI` - Peruvian Inti + * `TJR` - Tajikistani Ruble - * `PEN` - Peruvian Sol + * `TJS` - Tajikistani Somoni - * `PES` - Peruvian Sol (1863–1965) + * `TZS` - Tanzanian Shilling - * `PHP` - Philippine Peso + * `XTS` - Testing Currency Code - * `XPT` - Platinum + * `THB` - Thai Baht - * `PLN` - Polish Zloty + * `XXX` - The codes assigned for transactions where no currency is + involved - * `PLZ` - Polish Zloty (1950–1995) + * `TPE` - Timorese Escudo - * `PTE` - Portuguese Escudo + * `TOP` - Tongan Paʻanga - * `GWE` - Portuguese Guinea Escudo + * `TTD` - Trinidad & Tobago Dollar - * `QAR` - Qatari Rial + * `TND` - Tunisian Dinar - * `XRE` - RINET Funds + * `TRY` - Turkish Lira - * `RHD` - Rhodesian Dollar + * `TRL` - Turkish Lira (1922–2005) - * `RON` - Romanian Leu + * `TMT` - Turkmenistani Manat - * `ROL` - Romanian Leu (1952–2006) + * `TMM` - Turkmenistani Manat (1993–2009) - * `RUB` - Russian Ruble + * `USD` - US Dollar - * `RUR` - Russian Ruble (1991–1998) + * `USN` - US Dollar (Next day) - * `RWF` - Rwandan Franc + * `USS` - US Dollar (Same day) - * `SVC` - Salvadoran Colón + * `UGX` - Ugandan Shilling - * `WST` - Samoan Tala + * `UGS` - Ugandan Shilling (1966–1987) - * `SAR` - Saudi Riyal + * `UAH` - Ukrainian Hryvnia - * `RSD` - Serbian Dinar + * `UAK` - Ukrainian Karbovanets - * `CSD` - Serbian Dinar (2002–2006) + * `AED` - United Arab Emirates Dirham - * `SCR` - Seychellois Rupee + * `UYW` - Uruguayan Nominal Wage Index Unit - * `SLL` - Sierra Leonean Leone + * `UYU` - Uruguayan Peso - * `XAG` - Silver + * `UYP` - Uruguayan Peso (1975–1993) - * `SGD` - Singapore Dollar + * `UYI` - Uruguayan Peso (Indexed Units) - * `SKK` - Slovak Koruna + * `UZS` - Uzbekistani Som - * `SIT` - Slovenian Tolar + * `VUV` - Vanuatu Vatu - * `SBD` - Solomon Islands Dollar + * `VES` - Venezuelan Bolívar - * `SOS` - Somali Shilling + * `VEB` - Venezuelan Bolívar (1871–2008) - * `ZAR` - South African Rand + * `VEF` - Venezuelan Bolívar (2008–2018) - * `ZAL` - South African Rand (financial) + * `VND` - Vietnamese Dong - * `KRH` - South Korean Hwan (1953–1962) + * `VNN` - Vietnamese Dong (1978–1985) - * `KRW` - South Korean Won + * `CHE` - WIR Euro - * `KRO` - South Korean Won (1945–1953) + * `CHW` - WIR Franc - * `SSP` - South Sudanese Pound + * `XOF` - West African CFA Franc - * `SUR` - Soviet Rouble + * `YDD` - Yemeni Dinar - * `ESP` - Spanish Peseta + * `YER` - Yemeni Rial - * `ESA` - Spanish Peseta (A account) + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `ESB` - Spanish Peseta (convertible account) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `XDR` - Special Drawing Rights + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `LKR` - Sri Lankan Rupee + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `SHP` - St. Helena Pound + * `ZWN` - ZWN - * `XSU` - Sucre + * `ZRN` - Zairean New Zaire (1993–1998) - * `SDD` - Sudanese Dinar (1992–2007) + * `ZRZ` - Zairean Zaire (1971–1993) - * `SDG` - Sudanese Pound + * `ZMW` - Zambian Kwacha - * `SDP` - Sudanese Pound (1957–1998) + * `ZMK` - Zambian Kwacha (1968–2012) - * `SRD` - Surinamese Dollar + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `SRG` - Surinamese Guilder + * `ZWR` - Zimbabwean Dollar (2008) - * `SZL` - Swazi Lilangeni + * `ZWL` - Zimbabwean Dollar (2009) + payments: + type: optional>> + docs: Array of `Payment` object IDs + applied_payments: + type: optional>> + docs: >- + A list of the Payment Applied to Lines common models related to a + given Invoice, Credit Note, or Journal Entry. + accounting_period: + type: optional + docs: The accounting period that the CreditNote was generated in. + applied_to_lines: + type: optional> + docs: >- + A list of the CreditNote Applied to Lines common models related to a + given Credit Note + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + CreditNoteResponse: + properties: + model: CreditNote + warnings: list + errors: list + logs: optional> + source: + openapi: openapi/openapi.yml + CreditNoteStatusEnum: + enum: + - SUBMITTED + - AUTHORIZED + - PAID + docs: |- + * `SUBMITTED` - SUBMITTED + * `AUTHORIZED` - AUTHORIZED + * `PAID` - PAID + source: + openapi: openapi/openapi.yml + CreditOrDebitEnum: + enum: + - CREDIT + - DEBIT + docs: |- + * `CREDIT` - CREDIT + * `DEBIT` - DEBIT + source: + openapi: openapi/openapi.yml + DataPassthroughRequestMethod: + discriminated: false + union: + - MethodEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + DataPassthroughRequest: + docs: >- + # The DataPassthrough Object - * `SEK` - Swedish Krona + ### Description - * `CHF` - Swiss Franc + The `DataPassthrough` object is used to send information to an + otherwise-unsupported third-party endpoint. - * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra + ### Usage Example - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + Create a `DataPassthrough` to get team hierarchies from your Rippling + integration. + properties: + method: DataPassthroughRequestMethod + path: + type: string + docs: The path of the request in the third party's platform. + validation: + minLength: 1 + base_url_override: + type: optional + docs: An optional override of the third party's base url for the request. + validation: + minLength: 1 + data: + type: optional + docs: >- + The data with the request. You must include a `request_format` + parameter matching the data's format + validation: + minLength: 1 + multipart_form_data: + type: optional> + docs: >- + Pass an array of `MultipartFormField` objects in here instead of using + the `data` param if `request_format` is set to `MULTIPART`. + headers: + type: optional> + docs: >- + The headers to use for the request (Merge will handle the account's + authorization headers). `Content-Type` header is required for + passthrough. Choose content type corresponding to expected format of + receiving server. + request_format: optional + normalize_response: + type: optional + docs: >- + Optional. If true, the response will always be an object of the form + `{"type": T, "value": ...}` where `T` will be one of `string, boolean, + number, null, array, object`. + source: + openapi: openapi/openapi.yml + DebugModeLog: + properties: + log_id: string + dashboard_view: string + log_summary: DebugModelLogSummary + source: + openapi: openapi/openapi.yml + DebugModelLogSummary: + properties: + url: string + method: string + status_code: integer + source: + openapi: openapi/openapi.yml + EmployeeCompany: + discriminated: false + docs: The subsidiary that the employee belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + EmployeeStatus: + discriminated: false + docs: |- + The employee's status in the accounting system. - * `TVD` - TVD + * `ACTIVE` - ACTIVE + * `INACTIVE` - INACTIVE + union: + - Status895Enum + - string + source: + openapi: openapi/openapi.yml + inline: true + Employee: + docs: >- + # The Employee Object - * `TJR` - Tajikistani Ruble + ### Description - * `TJS` - Tajikistani Somoni + An `Employee` is an individual who works for the company of the linked + account. The `Employee` model contains both contractors and full time + employees. - * `TZS` - Tanzanian Shilling + * An `Employee` is a contractor if `is_contractor` property is `True` - * `XTS` - Testing Currency Code + * An `Employee` is a full time employee if `is_contractor` property is + `False` - * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is - involved + ### Usage Example - * `TPE` - Timorese Escudo + Fetch from the `LIST Employees` endpoint and view a company's employees. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + first_name: + type: optional + docs: The employee's first name. + validation: + maxLength: 255 + last_name: + type: optional + docs: The employee's last name. + validation: + maxLength: 255 + is_contractor: + type: optional + docs: '`True` if the employee is a contractor, `False` if not.' + employee_number: + type: optional + docs: The employee's internal identification number. + validation: + maxLength: 50 + email_address: + type: optional + docs: The employee's email address. + company: + type: optional + docs: The subsidiary that the employee belongs to. + status: + type: EmployeeStatus + docs: |- + The employee's status in the accounting system. - * `TOP` - Tongan Paʻanga + * `ACTIVE` - ACTIVE + * `INACTIVE` - INACTIVE + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + EnabledActionsEnum: + enum: + - READ + - WRITE + docs: |- + * `READ` - READ + * `WRITE` - WRITE + source: + openapi: openapi/openapi.yml + EncodingEnum: + enum: + - RAW + - BASE64 + - GZIP_BASE64 + docs: |- + * `RAW` - RAW + * `BASE64` - BASE64 + * `GZIP_BASE64` - GZIP_BASE64 + source: + openapi: openapi/openapi.yml + ErrorValidationProblem: + properties: + source: optional + title: string + detail: string + problem_type: string + source: + openapi: openapi/openapi.yml + EventTypeEnum: + enum: + - CREATED_REMOTE_PRODUCTION_API_KEY + - DELETED_REMOTE_PRODUCTION_API_KEY + - CREATED_TEST_API_KEY + - DELETED_TEST_API_KEY + - REGENERATED_PRODUCTION_API_KEY + - REGENERATED_WEBHOOK_SIGNATURE + - INVITED_USER + - TWO_FACTOR_AUTH_ENABLED + - TWO_FACTOR_AUTH_DISABLED + - DELETED_LINKED_ACCOUNT + - DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT + - CREATED_DESTINATION + - DELETED_DESTINATION + - CHANGED_DESTINATION + - CHANGED_SCOPES + - CHANGED_PERSONAL_INFORMATION + - CHANGED_ORGANIZATION_SETTINGS + - ENABLED_INTEGRATION + - DISABLED_INTEGRATION + - ENABLED_CATEGORY + - DISABLED_CATEGORY + - CHANGED_PASSWORD + - RESET_PASSWORD + - ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION + - ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT + - DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION + - DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT + - CREATED_INTEGRATION_WIDE_FIELD_MAPPING + - CREATED_LINKED_ACCOUNT_FIELD_MAPPING + - CHANGED_INTEGRATION_WIDE_FIELD_MAPPING + - CHANGED_LINKED_ACCOUNT_FIELD_MAPPING + - DELETED_INTEGRATION_WIDE_FIELD_MAPPING + - DELETED_LINKED_ACCOUNT_FIELD_MAPPING + - CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE + - CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE + - DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE + - FORCED_LINKED_ACCOUNT_RESYNC + - MUTED_ISSUE + - GENERATED_MAGIC_LINK + - ENABLED_MERGE_WEBHOOK + - DISABLED_MERGE_WEBHOOK + - MERGE_WEBHOOK_TARGET_CHANGED + - END_USER_CREDENTIALS_ACCESSED + docs: >- + * `CREATED_REMOTE_PRODUCTION_API_KEY` - CREATED_REMOTE_PRODUCTION_API_KEY - * `TTD` - Trinidad & Tobago Dollar + * `DELETED_REMOTE_PRODUCTION_API_KEY` - DELETED_REMOTE_PRODUCTION_API_KEY - * `TND` - Tunisian Dinar + * `CREATED_TEST_API_KEY` - CREATED_TEST_API_KEY - * `TRY` - Turkish Lira + * `DELETED_TEST_API_KEY` - DELETED_TEST_API_KEY - * `TRL` - Turkish Lira (1922–2005) + * `REGENERATED_PRODUCTION_API_KEY` - REGENERATED_PRODUCTION_API_KEY - * `TMT` - Turkmenistani Manat + * `REGENERATED_WEBHOOK_SIGNATURE` - REGENERATED_WEBHOOK_SIGNATURE - * `TMM` - Turkmenistani Manat (1993–2009) + * `INVITED_USER` - INVITED_USER - * `USD` - US Dollar + * `TWO_FACTOR_AUTH_ENABLED` - TWO_FACTOR_AUTH_ENABLED - * `USN` - US Dollar (Next day) + * `TWO_FACTOR_AUTH_DISABLED` - TWO_FACTOR_AUTH_DISABLED - * `USS` - US Dollar (Same day) + * `DELETED_LINKED_ACCOUNT` - DELETED_LINKED_ACCOUNT - * `UGX` - Ugandan Shilling + * `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT` - + DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT - * `UGS` - Ugandan Shilling (1966–1987) + * `CREATED_DESTINATION` - CREATED_DESTINATION - * `UAH` - Ukrainian Hryvnia + * `DELETED_DESTINATION` - DELETED_DESTINATION - * `UAK` - Ukrainian Karbovanets + * `CHANGED_DESTINATION` - CHANGED_DESTINATION - * `AED` - United Arab Emirates Dirham + * `CHANGED_SCOPES` - CHANGED_SCOPES - * `UYW` - Uruguayan Nominal Wage Index Unit + * `CHANGED_PERSONAL_INFORMATION` - CHANGED_PERSONAL_INFORMATION - * `UYU` - Uruguayan Peso + * `CHANGED_ORGANIZATION_SETTINGS` - CHANGED_ORGANIZATION_SETTINGS - * `UYP` - Uruguayan Peso (1975–1993) + * `ENABLED_INTEGRATION` - ENABLED_INTEGRATION - * `UYI` - Uruguayan Peso (Indexed Units) + * `DISABLED_INTEGRATION` - DISABLED_INTEGRATION - * `UZS` - Uzbekistani Som + * `ENABLED_CATEGORY` - ENABLED_CATEGORY - * `VUV` - Vanuatu Vatu + * `DISABLED_CATEGORY` - DISABLED_CATEGORY - * `VES` - Venezuelan Bolívar + * `CHANGED_PASSWORD` - CHANGED_PASSWORD - * `VEB` - Venezuelan Bolívar (1871–2008) + * `RESET_PASSWORD` - RESET_PASSWORD - * `VEF` - Venezuelan Bolívar (2008–2018) + * `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - + ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION - * `VND` - Vietnamese Dong + * `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - + ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT - * `VNN` - Vietnamese Dong (1978–1985) + * `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - + DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION - * `CHE` - WIR Euro + * `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - + DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT - * `CHW` - WIR Franc + * `CREATED_INTEGRATION_WIDE_FIELD_MAPPING` - + CREATED_INTEGRATION_WIDE_FIELD_MAPPING - * `XOF` - West African CFA Franc + * `CREATED_LINKED_ACCOUNT_FIELD_MAPPING` - + CREATED_LINKED_ACCOUNT_FIELD_MAPPING - * `YDD` - Yemeni Dinar + * `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING` - + CHANGED_INTEGRATION_WIDE_FIELD_MAPPING - * `YER` - Yemeni Rial + * `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING` - + CHANGED_LINKED_ACCOUNT_FIELD_MAPPING - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `DELETED_INTEGRATION_WIDE_FIELD_MAPPING` - + DELETED_INTEGRATION_WIDE_FIELD_MAPPING - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `DELETED_LINKED_ACCOUNT_FIELD_MAPPING` - + DELETED_LINKED_ACCOUNT_FIELD_MAPPING - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - + CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - + CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE - * `ZWN` - ZWN + * `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` - + DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE - * `ZRN` - Zairean New Zaire (1993–1998) + * `FORCED_LINKED_ACCOUNT_RESYNC` - FORCED_LINKED_ACCOUNT_RESYNC - * `ZRZ` - Zairean Zaire (1971–1993) + * `MUTED_ISSUE` - MUTED_ISSUE - * `ZMW` - Zambian Kwacha + * `GENERATED_MAGIC_LINK` - GENERATED_MAGIC_LINK - * `ZMK` - Zambian Kwacha (1968–2012) + * `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK - * `ZWR` - Zimbabwean Dollar (2008) + * `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED - * `ZWL` - Zimbabwean Dollar (2009) - union: - - TransactionCurrencyEnum - - string + * `END_USER_CREDENTIALS_ACCESSED` - END_USER_CREDENTIALS_ACCESSED source: openapi: openapi/openapi.yml - inline: true - ExpenseLineAccount: + ExpenseAccount: discriminated: false docs: The expense's payment account. union: @@ -18329,7 +13771,7 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseLineContact: + ExpenseContact: discriminated: false docs: The expense's contact. union: @@ -18340,732 +13782,653 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseLineProject: + ExpenseCurrency: discriminated: false - union: - - type: string - validation: - format: uuid - - Project - source: - openapi: openapi/openapi.yml - inline: true - ExpenseLine: - docs: |- - # The ExpenseLine Object - ### Description - The `ExpenseLine` object is used to represent an expense's line items. - - ### Usage Example - Fetch from the `GET Expense` endpoint and view the expense's line items. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - item: - type: optional - docs: The line's item. - net_amount: - type: optional - docs: The line's net amount. - tracking_category: - type: optional - availability: deprecated - tracking_categories: - type: optional>> - docs: The expense line item's associated tracking categories. - company: - type: optional - docs: The company the expense belongs to. - validation: - format: uuid - employee: - type: optional - docs: The employee this overall transaction relates to. - currency: - type: optional - docs: >- - The expense line item's currency. + docs: >- + The expense's currency. - * `XUA` - ADB Unit of Account + * `XUA` - ADB Unit of Account - * `AFN` - Afghan Afghani + * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) + * `AFA` - Afghan Afghani (1927–2002) - * `ALL` - Albanian Lek + * `ALL` - Albanian Lek - * `ALK` - Albanian Lek (1946–1965) + * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar + * `DZD` - Algerian Dinar - * `ADP` - Andorran Peseta + * `ADP` - Andorran Peseta - * `AOA` - Angolan Kwanza + * `AOA` - Angolan Kwanza - * `AOK` - Angolan Kwanza (1977–1991) + * `AOK` - Angolan Kwanza (1977–1991) - * `AON` - Angolan New Kwanza (1990–2000) + * `AON` - Angolan New Kwanza (1990–2000) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `ARA` - Argentine Austral + * `ARA` - Argentine Austral - * `ARS` - Argentine Peso + * `ARS` - Argentine Peso - * `ARM` - Argentine Peso (1881–1970) + * `ARM` - Argentine Peso (1881–1970) - * `ARP` - Argentine Peso (1983–1985) + * `ARP` - Argentine Peso (1983–1985) - * `ARL` - Argentine Peso Ley (1970–1983) + * `ARL` - Argentine Peso Ley (1970–1983) - * `AMD` - Armenian Dram + * `AMD` - Armenian Dram - * `AWG` - Aruban Florin + * `AWG` - Aruban Florin - * `AUD` - Australian Dollar + * `AUD` - Australian Dollar - * `ATS` - Austrian Schilling + * `ATS` - Austrian Schilling - * `AZN` - Azerbaijani Manat + * `AZN` - Azerbaijani Manat - * `AZM` - Azerbaijani Manat (1993–2006) + * `AZM` - Azerbaijani Manat (1993–2006) - * `BSD` - Bahamian Dollar + * `BSD` - Bahamian Dollar - * `BHD` - Bahraini Dinar + * `BHD` - Bahraini Dinar - * `BDT` - Bangladeshi Taka + * `BDT` - Bangladeshi Taka - * `BBD` - Barbadian Dollar + * `BBD` - Barbadian Dollar - * `BYN` - Belarusian Ruble + * `BYN` - Belarusian Ruble - * `BYB` - Belarusian Ruble (1994–1999) + * `BYB` - Belarusian Ruble (1994–1999) - * `BYR` - Belarusian Ruble (2000–2016) + * `BYR` - Belarusian Ruble (2000–2016) - * `BEF` - Belgian Franc + * `BEF` - Belgian Franc - * `BEC` - Belgian Franc (convertible) + * `BEC` - Belgian Franc (convertible) - * `BEL` - Belgian Franc (financial) + * `BEL` - Belgian Franc (financial) - * `BZD` - Belize Dollar + * `BZD` - Belize Dollar - * `BMD` - Bermudan Dollar + * `BMD` - Bermudan Dollar - * `BTN` - Bhutanese Ngultrum + * `BTN` - Bhutanese Ngultrum - * `BOB` - Bolivian Boliviano + * `BOB` - Bolivian Boliviano - * `BOL` - Bolivian Boliviano (1863–1963) + * `BOL` - Bolivian Boliviano (1863–1963) - * `BOV` - Bolivian Mvdol + * `BOV` - Bolivian Mvdol - * `BOP` - Bolivian Peso + * `BOP` - Bolivian Peso - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BWP` - Botswanan Pula + * `BWP` - Botswanan Pula - * `BRC` - Brazilian Cruzado (1986–1989) + * `BRC` - Brazilian Cruzado (1986–1989) - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BRN` - Brazilian New Cruzado (1989–1990) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BRL` - Brazilian Real + * `BRL` - Brazilian Real - * `GBP` - British Pound + * `GBP` - British Pound - * `BND` - Brunei Dollar + * `BND` - Brunei Dollar - * `BGL` - Bulgarian Hard Lev + * `BGL` - Bulgarian Hard Lev - * `BGN` - Bulgarian Lev + * `BGN` - Bulgarian Lev - * `BGO` - Bulgarian Lev (1879–1952) + * `BGO` - Bulgarian Lev (1879–1952) - * `BGM` - Bulgarian Socialist Lev + * `BGM` - Bulgarian Socialist Lev - * `BUK` - Burmese Kyat + * `BUK` - Burmese Kyat - * `BIF` - Burundian Franc + * `BIF` - Burundian Franc - * `XPF` - CFP Franc + * `XPF` - CFP Franc - * `KHR` - Cambodian Riel + * `KHR` - Cambodian Riel - * `CAD` - Canadian Dollar + * `CAD` - Canadian Dollar - * `CVE` - Cape Verdean Escudo + * `CVE` - Cape Verdean Escudo - * `KYD` - Cayman Islands Dollar + * `KYD` - Cayman Islands Dollar - * `XAF` - Central African CFA Franc + * `XAF` - Central African CFA Franc - * `CLE` - Chilean Escudo + * `CLE` - Chilean Escudo - * `CLP` - Chilean Peso + * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) + * `CLF` - Chilean Unit of Account (UF) - * `CNX` - Chinese People’s Bank Dollar + * `CNX` - Chinese People’s Bank Dollar - * `CNY` - Chinese Yuan + * `CNY` - Chinese Yuan - * `CNH` - Chinese Yuan (offshore) + * `CNH` - Chinese Yuan (offshore) - * `COP` - Colombian Peso + * `COP` - Colombian Peso - * `COU` - Colombian Real Value Unit + * `COU` - Colombian Real Value Unit - * `KMF` - Comorian Franc + * `KMF` - Comorian Franc - * `CDF` - Congolese Franc + * `CDF` - Congolese Franc - * `CRC` - Costa Rican Colón + * `CRC` - Costa Rican Colón - * `HRD` - Croatian Dinar + * `HRD` - Croatian Dinar - * `HRK` - Croatian Kuna + * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso + * `CUC` - Cuban Convertible Peso - * `CUP` - Cuban Peso + * `CUP` - Cuban Peso - * `CYP` - Cypriot Pound + * `CYP` - Cypriot Pound - * `CZK` - Czech Koruna + * `CZK` - Czech Koruna - * `CSK` - Czechoslovak Hard Koruna + * `CSK` - Czechoslovak Hard Koruna - * `DKK` - Danish Krone + * `DKK` - Danish Krone - * `DJF` - Djiboutian Franc + * `DJF` - Djiboutian Franc - * `DOP` - Dominican Peso + * `DOP` - Dominican Peso - * `NLG` - Dutch Guilder + * `NLG` - Dutch Guilder - * `XCD` - East Caribbean Dollar + * `XCD` - East Caribbean Dollar - * `DDM` - East German Mark + * `DDM` - East German Mark - * `ECS` - Ecuadorian Sucre + * `ECS` - Ecuadorian Sucre - * `ECV` - Ecuadorian Unit of Constant Value + * `ECV` - Ecuadorian Unit of Constant Value - * `EGP` - Egyptian Pound + * `EGP` - Egyptian Pound - * `GQE` - Equatorial Guinean Ekwele + * `GQE` - Equatorial Guinean Ekwele - * `ERN` - Eritrean Nakfa + * `ERN` - Eritrean Nakfa - * `EEK` - Estonian Kroon + * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr + * `ETB` - Ethiopian Birr - * `EUR` - Euro + * `EUR` - Euro - * `XBA` - European Composite Unit + * `XBA` - European Composite Unit - * `XEU` - European Currency Unit + * `XEU` - European Currency Unit - * `XBB` - European Monetary Unit + * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) + * `XBC` - European Unit of Account (XBC) - * `XBD` - European Unit of Account (XBD) + * `XBD` - European Unit of Account (XBD) - * `FKP` - Falkland Islands Pound + * `FKP` - Falkland Islands Pound - * `FJD` - Fijian Dollar + * `FJD` - Fijian Dollar - * `FIM` - Finnish Markka + * `FIM` - Finnish Markka - * `FRF` - French Franc + * `FRF` - French Franc - * `XFO` - French Gold Franc + * `XFO` - French Gold Franc - * `XFU` - French UIC-Franc + * `XFU` - French UIC-Franc - * `GMD` - Gambian Dalasi + * `GMD` - Gambian Dalasi - * `GEK` - Georgian Kupon Larit + * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari + * `GEL` - Georgian Lari - * `DEM` - German Mark + * `DEM` - German Mark - * `GHS` - Ghanaian Cedi + * `GHS` - Ghanaian Cedi - * `GHC` - Ghanaian Cedi (1979–2007) + * `GHC` - Ghanaian Cedi (1979–2007) - * `GIP` - Gibraltar Pound + * `GIP` - Gibraltar Pound - * `XAU` - Gold + * `XAU` - Gold - * `GRD` - Greek Drachma + * `GRD` - Greek Drachma - * `GTQ` - Guatemalan Quetzal + * `GTQ` - Guatemalan Quetzal - * `GWP` - Guinea-Bissau Peso + * `GWP` - Guinea-Bissau Peso - * `GNF` - Guinean Franc + * `GNF` - Guinean Franc - * `GNS` - Guinean Syli + * `GNS` - Guinean Syli - * `GYD` - Guyanaese Dollar + * `GYD` - Guyanaese Dollar - * `HTG` - Haitian Gourde + * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira + * `HNL` - Honduran Lempira - * `HKD` - Hong Kong Dollar + * `HKD` - Hong Kong Dollar - * `HUF` - Hungarian Forint + * `HUF` - Hungarian Forint - * `IMP` - IMP + * `IMP` - IMP - * `ISK` - Icelandic Króna + * `ISK` - Icelandic Króna - * `ISJ` - Icelandic Króna (1918–1981) + * `ISJ` - Icelandic Króna (1918–1981) - * `INR` - Indian Rupee + * `INR` - Indian Rupee - * `IDR` - Indonesian Rupiah + * `IDR` - Indonesian Rupiah - * `IRR` - Iranian Rial + * `IRR` - Iranian Rial - * `IQD` - Iraqi Dinar + * `IQD` - Iraqi Dinar - * `IEP` - Irish Pound + * `IEP` - Irish Pound - * `ILS` - Israeli New Shekel + * `ILS` - Israeli New Shekel - * `ILP` - Israeli Pound + * `ILP` - Israeli Pound - * `ILR` - Israeli Shekel (1980–1985) + * `ILR` - Israeli Shekel (1980–1985) - * `ITL` - Italian Lira + * `ITL` - Italian Lira - * `JMD` - Jamaican Dollar + * `JMD` - Jamaican Dollar - * `JPY` - Japanese Yen + * `JPY` - Japanese Yen - * `JOD` - Jordanian Dinar + * `JOD` - Jordanian Dinar - * `KZT` - Kazakhstani Tenge + * `KZT` - Kazakhstani Tenge - * `KES` - Kenyan Shilling + * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar + * `KWD` - Kuwaiti Dinar - * `KGS` - Kyrgystani Som + * `KGS` - Kyrgystani Som - * `LAK` - Laotian Kip + * `LAK` - Laotian Kip - * `LVL` - Latvian Lats + * `LVL` - Latvian Lats - * `LVR` - Latvian Ruble + * `LVR` - Latvian Ruble - * `LBP` - Lebanese Pound + * `LBP` - Lebanese Pound - * `LSL` - Lesotho Loti + * `LSL` - Lesotho Loti - * `LRD` - Liberian Dollar + * `LRD` - Liberian Dollar - * `LYD` - Libyan Dinar + * `LYD` - Libyan Dinar - * `LTL` - Lithuanian Litas + * `LTL` - Lithuanian Litas - * `LTT` - Lithuanian Talonas + * `LTT` - Lithuanian Talonas - * `LUL` - Luxembourg Financial Franc + * `LUL` - Luxembourg Financial Franc - * `LUC` - Luxembourgian Convertible Franc + * `LUC` - Luxembourgian Convertible Franc - * `LUF` - Luxembourgian Franc + * `LUF` - Luxembourgian Franc - * `MOP` - Macanese Pataca + * `MOP` - Macanese Pataca - * `MKD` - Macedonian Denar + * `MKD` - Macedonian Denar - * `MKN` - Macedonian Denar (1992–1993) + * `MKN` - Macedonian Denar (1992–1993) - * `MGA` - Malagasy Ariary + * `MGA` - Malagasy Ariary - * `MGF` - Malagasy Franc + * `MGF` - Malagasy Franc - * `MWK` - Malawian Kwacha + * `MWK` - Malawian Kwacha - * `MYR` - Malaysian Ringgit + * `MYR` - Malaysian Ringgit - * `MVR` - Maldivian Rufiyaa + * `MVR` - Maldivian Rufiyaa - * `MVP` - Maldivian Rupee (1947–1981) + * `MVP` - Maldivian Rupee (1947–1981) - * `MLF` - Malian Franc + * `MLF` - Malian Franc - * `MTL` - Maltese Lira + * `MTL` - Maltese Lira - * `MTP` - Maltese Pound + * `MTP` - Maltese Pound - * `MRU` - Mauritanian Ouguiya + * `MRU` - Mauritanian Ouguiya - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MUR` - Mauritian Rupee + * `MUR` - Mauritian Rupee - * `MXV` - Mexican Investment Unit + * `MXV` - Mexican Investment Unit - * `MXN` - Mexican Peso + * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) + * `MXP` - Mexican Silver Peso (1861–1992) - * `MDC` - Moldovan Cupon + * `MDC` - Moldovan Cupon - * `MDL` - Moldovan Leu + * `MDL` - Moldovan Leu - * `MCF` - Monegasque Franc + * `MCF` - Monegasque Franc - * `MNT` - Mongolian Tugrik + * `MNT` - Mongolian Tugrik - * `MAD` - Moroccan Dirham + * `MAD` - Moroccan Dirham - * `MAF` - Moroccan Franc + * `MAF` - Moroccan Franc - * `MZE` - Mozambican Escudo + * `MZE` - Mozambican Escudo - * `MZN` - Mozambican Metical + * `MZN` - Mozambican Metical - * `MZM` - Mozambican Metical (1980–2006) + * `MZM` - Mozambican Metical (1980–2006) - * `MMK` - Myanmar Kyat + * `MMK` - Myanmar Kyat - * `NAD` - Namibian Dollar + * `NAD` - Namibian Dollar - * `NPR` - Nepalese Rupee + * `NPR` - Nepalese Rupee - * `ANG` - Netherlands Antillean Guilder + * `ANG` - Netherlands Antillean Guilder - * `TWD` - New Taiwan Dollar + * `TWD` - New Taiwan Dollar - * `NZD` - New Zealand Dollar + * `NZD` - New Zealand Dollar - * `NIO` - Nicaraguan Córdoba + * `NIO` - Nicaraguan Córdoba - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NGN` - Nigerian Naira + * `NGN` - Nigerian Naira - * `KPW` - North Korean Won + * `KPW` - North Korean Won - * `NOK` - Norwegian Krone + * `NOK` - Norwegian Krone - * `OMR` - Omani Rial + * `OMR` - Omani Rial - * `PKR` - Pakistani Rupee + * `PKR` - Pakistani Rupee - * `XPD` - Palladium + * `XPD` - Palladium - * `PAB` - Panamanian Balboa + * `PAB` - Panamanian Balboa - * `PGK` - Papua New Guinean Kina + * `PGK` - Papua New Guinean Kina - * `PYG` - Paraguayan Guarani + * `PYG` - Paraguayan Guarani - * `PEI` - Peruvian Inti + * `PEI` - Peruvian Inti - * `PEN` - Peruvian Sol + * `PEN` - Peruvian Sol - * `PES` - Peruvian Sol (1863–1965) + * `PES` - Peruvian Sol (1863–1965) - * `PHP` - Philippine Peso + * `PHP` - Philippine Peso - * `XPT` - Platinum + * `XPT` - Platinum - * `PLN` - Polish Zloty + * `PLN` - Polish Zloty - * `PLZ` - Polish Zloty (1950–1995) + * `PLZ` - Polish Zloty (1950–1995) - * `PTE` - Portuguese Escudo + * `PTE` - Portuguese Escudo - * `GWE` - Portuguese Guinea Escudo + * `GWE` - Portuguese Guinea Escudo - * `QAR` - Qatari Rial + * `QAR` - Qatari Rial - * `XRE` - RINET Funds + * `XRE` - RINET Funds - * `RHD` - Rhodesian Dollar + * `RHD` - Rhodesian Dollar - * `RON` - Romanian Leu + * `RON` - Romanian Leu - * `ROL` - Romanian Leu (1952–2006) + * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble + * `RUB` - Russian Ruble - * `RUR` - Russian Ruble (1991–1998) + * `RUR` - Russian Ruble (1991–1998) - * `RWF` - Rwandan Franc + * `RWF` - Rwandan Franc - * `SVC` - Salvadoran Colón + * `SVC` - Salvadoran Colón - * `WST` - Samoan Tala + * `WST` - Samoan Tala - * `SAR` - Saudi Riyal + * `SAR` - Saudi Riyal - * `RSD` - Serbian Dinar + * `RSD` - Serbian Dinar - * `CSD` - Serbian Dinar (2002–2006) + * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee + * `SCR` - Seychellois Rupee - * `SLL` - Sierra Leonean Leone + * `SLL` - Sierra Leonean Leone - * `XAG` - Silver + * `XAG` - Silver - * `SGD` - Singapore Dollar + * `SGD` - Singapore Dollar - * `SKK` - Slovak Koruna + * `SKK` - Slovak Koruna - * `SIT` - Slovenian Tolar + * `SIT` - Slovenian Tolar - * `SBD` - Solomon Islands Dollar + * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling + * `SOS` - Somali Shilling - * `ZAR` - South African Rand + * `ZAR` - South African Rand - * `ZAL` - South African Rand (financial) + * `ZAL` - South African Rand (financial) - * `KRH` - South Korean Hwan (1953–1962) + * `KRH` - South Korean Hwan (1953–1962) - * `KRW` - South Korean Won + * `KRW` - South Korean Won - * `KRO` - South Korean Won (1945–1953) + * `KRO` - South Korean Won (1945–1953) - * `SSP` - South Sudanese Pound + * `SSP` - South Sudanese Pound - * `SUR` - Soviet Rouble + * `SUR` - Soviet Rouble - * `ESP` - Spanish Peseta + * `ESP` - Spanish Peseta - * `ESA` - Spanish Peseta (A account) + * `ESA` - Spanish Peseta (A account) - * `ESB` - Spanish Peseta (convertible account) + * `ESB` - Spanish Peseta (convertible account) - * `XDR` - Special Drawing Rights + * `XDR` - Special Drawing Rights - * `LKR` - Sri Lankan Rupee + * `LKR` - Sri Lankan Rupee - * `SHP` - St. Helena Pound + * `SHP` - St. Helena Pound - * `XSU` - Sucre + * `XSU` - Sucre - * `SDD` - Sudanese Dinar (1992–2007) + * `SDD` - Sudanese Dinar (1992–2007) - * `SDG` - Sudanese Pound + * `SDG` - Sudanese Pound - * `SDP` - Sudanese Pound (1957–1998) + * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar + * `SRD` - Surinamese Dollar - * `SRG` - Surinamese Guilder + * `SRG` - Surinamese Guilder - * `SZL` - Swazi Lilangeni + * `SZL` - Swazi Lilangeni - * `SEK` - Swedish Krona + * `SEK` - Swedish Krona - * `CHF` - Swiss Franc + * `CHF` - Swiss Franc - * `SYP` - Syrian Pound + * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra + * `STN` - São Tomé & Príncipe Dobra - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `TVD` - TVD + * `TVD` - TVD - * `TJR` - Tajikistani Ruble + * `TJR` - Tajikistani Ruble - * `TJS` - Tajikistani Somoni + * `TJS` - Tajikistani Somoni - * `TZS` - Tanzanian Shilling + * `TZS` - Tanzanian Shilling - * `XTS` - Testing Currency Code + * `XTS` - Testing Currency Code - * `THB` - Thai Baht + * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is - involved + * `XXX` - The codes assigned for transactions where no currency is + involved - * `TPE` - Timorese Escudo + * `TPE` - Timorese Escudo - * `TOP` - Tongan Paʻanga + * `TOP` - Tongan Paʻanga - * `TTD` - Trinidad & Tobago Dollar + * `TTD` - Trinidad & Tobago Dollar - * `TND` - Tunisian Dinar + * `TND` - Tunisian Dinar - * `TRY` - Turkish Lira + * `TRY` - Turkish Lira - * `TRL` - Turkish Lira (1922–2005) + * `TRL` - Turkish Lira (1922–2005) - * `TMT` - Turkmenistani Manat + * `TMT` - Turkmenistani Manat - * `TMM` - Turkmenistani Manat (1993–2009) + * `TMM` - Turkmenistani Manat (1993–2009) - * `USD` - US Dollar + * `USD` - US Dollar - * `USN` - US Dollar (Next day) + * `USN` - US Dollar (Next day) - * `USS` - US Dollar (Same day) + * `USS` - US Dollar (Same day) - * `UGX` - Ugandan Shilling + * `UGX` - Ugandan Shilling - * `UGS` - Ugandan Shilling (1966–1987) + * `UGS` - Ugandan Shilling (1966–1987) - * `UAH` - Ukrainian Hryvnia + * `UAH` - Ukrainian Hryvnia - * `UAK` - Ukrainian Karbovanets + * `UAK` - Ukrainian Karbovanets - * `AED` - United Arab Emirates Dirham + * `AED` - United Arab Emirates Dirham - * `UYW` - Uruguayan Nominal Wage Index Unit + * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYU` - Uruguayan Peso + * `UYU` - Uruguayan Peso - * `UYP` - Uruguayan Peso (1975–1993) + * `UYP` - Uruguayan Peso (1975–1993) - * `UYI` - Uruguayan Peso (Indexed Units) + * `UYI` - Uruguayan Peso (Indexed Units) - * `UZS` - Uzbekistani Som + * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu + * `VUV` - Vanuatu Vatu - * `VES` - Venezuelan Bolívar + * `VES` - Venezuelan Bolívar - * `VEB` - Venezuelan Bolívar (1871–2008) + * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEF` - Venezuelan Bolívar (2008–2018) + * `VEF` - Venezuelan Bolívar (2008–2018) - * `VND` - Vietnamese Dong + * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) + * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro + * `CHE` - WIR Euro - * `CHW` - WIR Franc + * `CHW` - WIR Franc - * `XOF` - West African CFA Franc + * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar + * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial + * `YER` - Yemeni Rial - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN + * `ZWN` - ZWN - * `ZRN` - Zairean New Zaire (1993–1998) + * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRZ` - Zairean Zaire (1971–1993) + * `ZRZ` - Zairean Zaire (1971–1993) - * `ZMW` - Zambian Kwacha + * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) + * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWR` - Zimbabwean Dollar (2008) + * `ZWR` - Zimbabwean Dollar (2008) - * `ZWL` - Zimbabwean Dollar (2009) - account: - type: optional - docs: The expense's payment account. - contact: - type: optional - docs: The expense's contact. - project: optional - description: - type: optional - docs: The description of the item that was purchased by the company. - exchange_rate: - type: optional - docs: The expense line item's exchange rate. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - tax_rate: - type: optional - docs: The tax rate that applies to this line item. - validation: - format: uuid - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only + * `ZWL` - Zimbabwean Dollar (2009) + union: + - TransactionCurrencyEnum + - string source: openapi: openapi/openapi.yml - ExpenseLineRequestItem: + inline: true + ExpenseCompany: discriminated: false - docs: The line's item. + docs: The company the expense belongs to. union: - type: string validation: format: uuid - - Item + - CompanyInfo source: openapi: openapi/openapi.yml inline: true - ExpenseLineRequestTrackingCategory: + ExpenseEmployee: discriminated: false + docs: The employee this overall transaction relates to. union: - type: string validation: format: uuid - - TrackingCategory + - Employee source: openapi: openapi/openapi.yml inline: true - ExpenseLineRequestTrackingCategoriesItem: + ExpenseTrackingCategoriesItem: discriminated: false union: - type: string @@ -19075,1402 +14438,1444 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseLineRequestEmployee: + ExpenseAccountingPeriod: discriminated: false - docs: The employee this overall transaction relates to. + docs: The accounting period that the Expense was generated in. union: - type: string validation: format: uuid - - Employee - source: - openapi: openapi/openapi.yml - inline: true - ExpenseLineRequestCurrency: - discriminated: false - docs: >- - The expense line item's currency. + - AccountingPeriod + source: + openapi: openapi/openapi.yml + inline: true + Expense: + docs: >- + # The Expense Object + + ### Description + + The `Expense` object is used to represent a direct purchase by a business, + typically made with a check, credit card, or cash. Each `Expense` object + is dedicated to a grouping of expenses, with each expense recorded in the + lines object. + + + The `Expense` object is used also used to represent refunds to direct + purchases. Refunds can be distinguished from purchases by the amount sign + of the records. Expense objects with a negative amount are purchases and + `Expense` objects with a positive amount are refunds to those purchases. + + + ### Usage Example + + Fetch from the `GET Expense` endpoint and view a company's expense. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + transaction_date: + type: optional + docs: When the transaction occurred. + remote_created_at: + type: optional + docs: When the expense was created. + account: + type: optional + docs: The expense's payment account. + contact: + type: optional + docs: The expense's contact. + total_amount: + type: optional + docs: The expense's total amount. + sub_total: + type: optional + docs: The expense's total amount before tax. + total_tax_amount: + type: optional + docs: The expense's total tax amount. + currency: + type: optional + docs: >- + The expense's currency. - * `XUA` - ADB Unit of Account + * `XUA` - ADB Unit of Account - * `AFN` - Afghan Afghani + * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) + * `AFA` - Afghan Afghani (1927–2002) - * `ALL` - Albanian Lek + * `ALL` - Albanian Lek - * `ALK` - Albanian Lek (1946–1965) + * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar + * `DZD` - Algerian Dinar - * `ADP` - Andorran Peseta + * `ADP` - Andorran Peseta - * `AOA` - Angolan Kwanza + * `AOA` - Angolan Kwanza - * `AOK` - Angolan Kwanza (1977–1991) + * `AOK` - Angolan Kwanza (1977–1991) - * `AON` - Angolan New Kwanza (1990–2000) + * `AON` - Angolan New Kwanza (1990–2000) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `ARA` - Argentine Austral + * `ARA` - Argentine Austral - * `ARS` - Argentine Peso + * `ARS` - Argentine Peso - * `ARM` - Argentine Peso (1881–1970) + * `ARM` - Argentine Peso (1881–1970) - * `ARP` - Argentine Peso (1983–1985) + * `ARP` - Argentine Peso (1983–1985) - * `ARL` - Argentine Peso Ley (1970–1983) + * `ARL` - Argentine Peso Ley (1970–1983) - * `AMD` - Armenian Dram + * `AMD` - Armenian Dram - * `AWG` - Aruban Florin + * `AWG` - Aruban Florin - * `AUD` - Australian Dollar + * `AUD` - Australian Dollar - * `ATS` - Austrian Schilling + * `ATS` - Austrian Schilling - * `AZN` - Azerbaijani Manat + * `AZN` - Azerbaijani Manat - * `AZM` - Azerbaijani Manat (1993–2006) + * `AZM` - Azerbaijani Manat (1993–2006) - * `BSD` - Bahamian Dollar + * `BSD` - Bahamian Dollar - * `BHD` - Bahraini Dinar + * `BHD` - Bahraini Dinar - * `BDT` - Bangladeshi Taka + * `BDT` - Bangladeshi Taka - * `BBD` - Barbadian Dollar + * `BBD` - Barbadian Dollar - * `BYN` - Belarusian Ruble + * `BYN` - Belarusian Ruble - * `BYB` - Belarusian Ruble (1994–1999) + * `BYB` - Belarusian Ruble (1994–1999) - * `BYR` - Belarusian Ruble (2000–2016) + * `BYR` - Belarusian Ruble (2000–2016) - * `BEF` - Belgian Franc + * `BEF` - Belgian Franc - * `BEC` - Belgian Franc (convertible) + * `BEC` - Belgian Franc (convertible) - * `BEL` - Belgian Franc (financial) + * `BEL` - Belgian Franc (financial) - * `BZD` - Belize Dollar + * `BZD` - Belize Dollar - * `BMD` - Bermudan Dollar + * `BMD` - Bermudan Dollar - * `BTN` - Bhutanese Ngultrum + * `BTN` - Bhutanese Ngultrum - * `BOB` - Bolivian Boliviano + * `BOB` - Bolivian Boliviano - * `BOL` - Bolivian Boliviano (1863–1963) + * `BOL` - Bolivian Boliviano (1863–1963) - * `BOV` - Bolivian Mvdol + * `BOV` - Bolivian Mvdol - * `BOP` - Bolivian Peso + * `BOP` - Bolivian Peso - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BWP` - Botswanan Pula + * `BWP` - Botswanan Pula - * `BRC` - Brazilian Cruzado (1986–1989) + * `BRC` - Brazilian Cruzado (1986–1989) - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BRN` - Brazilian New Cruzado (1989–1990) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BRL` - Brazilian Real + * `BRL` - Brazilian Real - * `GBP` - British Pound + * `GBP` - British Pound - * `BND` - Brunei Dollar + * `BND` - Brunei Dollar - * `BGL` - Bulgarian Hard Lev + * `BGL` - Bulgarian Hard Lev - * `BGN` - Bulgarian Lev + * `BGN` - Bulgarian Lev - * `BGO` - Bulgarian Lev (1879–1952) + * `BGO` - Bulgarian Lev (1879–1952) - * `BGM` - Bulgarian Socialist Lev + * `BGM` - Bulgarian Socialist Lev - * `BUK` - Burmese Kyat + * `BUK` - Burmese Kyat - * `BIF` - Burundian Franc + * `BIF` - Burundian Franc - * `XPF` - CFP Franc + * `XPF` - CFP Franc - * `KHR` - Cambodian Riel + * `KHR` - Cambodian Riel - * `CAD` - Canadian Dollar + * `CAD` - Canadian Dollar - * `CVE` - Cape Verdean Escudo + * `CVE` - Cape Verdean Escudo - * `KYD` - Cayman Islands Dollar + * `KYD` - Cayman Islands Dollar - * `XAF` - Central African CFA Franc + * `XAF` - Central African CFA Franc - * `CLE` - Chilean Escudo + * `CLE` - Chilean Escudo - * `CLP` - Chilean Peso + * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) + * `CLF` - Chilean Unit of Account (UF) - * `CNX` - Chinese People’s Bank Dollar + * `CNX` - Chinese People’s Bank Dollar - * `CNY` - Chinese Yuan + * `CNY` - Chinese Yuan - * `CNH` - Chinese Yuan (offshore) + * `CNH` - Chinese Yuan (offshore) - * `COP` - Colombian Peso + * `COP` - Colombian Peso - * `COU` - Colombian Real Value Unit + * `COU` - Colombian Real Value Unit - * `KMF` - Comorian Franc + * `KMF` - Comorian Franc - * `CDF` - Congolese Franc + * `CDF` - Congolese Franc - * `CRC` - Costa Rican Colón + * `CRC` - Costa Rican Colón - * `HRD` - Croatian Dinar + * `HRD` - Croatian Dinar - * `HRK` - Croatian Kuna + * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso + * `CUC` - Cuban Convertible Peso - * `CUP` - Cuban Peso + * `CUP` - Cuban Peso - * `CYP` - Cypriot Pound + * `CYP` - Cypriot Pound - * `CZK` - Czech Koruna + * `CZK` - Czech Koruna - * `CSK` - Czechoslovak Hard Koruna + * `CSK` - Czechoslovak Hard Koruna - * `DKK` - Danish Krone + * `DKK` - Danish Krone - * `DJF` - Djiboutian Franc + * `DJF` - Djiboutian Franc - * `DOP` - Dominican Peso + * `DOP` - Dominican Peso - * `NLG` - Dutch Guilder + * `NLG` - Dutch Guilder - * `XCD` - East Caribbean Dollar + * `XCD` - East Caribbean Dollar - * `DDM` - East German Mark + * `DDM` - East German Mark - * `ECS` - Ecuadorian Sucre + * `ECS` - Ecuadorian Sucre - * `ECV` - Ecuadorian Unit of Constant Value + * `ECV` - Ecuadorian Unit of Constant Value - * `EGP` - Egyptian Pound + * `EGP` - Egyptian Pound - * `GQE` - Equatorial Guinean Ekwele + * `GQE` - Equatorial Guinean Ekwele - * `ERN` - Eritrean Nakfa + * `ERN` - Eritrean Nakfa - * `EEK` - Estonian Kroon + * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr + * `ETB` - Ethiopian Birr - * `EUR` - Euro + * `EUR` - Euro - * `XBA` - European Composite Unit + * `XBA` - European Composite Unit - * `XEU` - European Currency Unit + * `XEU` - European Currency Unit - * `XBB` - European Monetary Unit + * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) + * `XBC` - European Unit of Account (XBC) - * `XBD` - European Unit of Account (XBD) + * `XBD` - European Unit of Account (XBD) - * `FKP` - Falkland Islands Pound + * `FKP` - Falkland Islands Pound - * `FJD` - Fijian Dollar + * `FJD` - Fijian Dollar - * `FIM` - Finnish Markka + * `FIM` - Finnish Markka - * `FRF` - French Franc + * `FRF` - French Franc - * `XFO` - French Gold Franc + * `XFO` - French Gold Franc - * `XFU` - French UIC-Franc + * `XFU` - French UIC-Franc - * `GMD` - Gambian Dalasi + * `GMD` - Gambian Dalasi - * `GEK` - Georgian Kupon Larit + * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari + * `GEL` - Georgian Lari - * `DEM` - German Mark + * `DEM` - German Mark - * `GHS` - Ghanaian Cedi + * `GHS` - Ghanaian Cedi - * `GHC` - Ghanaian Cedi (1979–2007) + * `GHC` - Ghanaian Cedi (1979–2007) - * `GIP` - Gibraltar Pound + * `GIP` - Gibraltar Pound - * `XAU` - Gold + * `XAU` - Gold - * `GRD` - Greek Drachma + * `GRD` - Greek Drachma - * `GTQ` - Guatemalan Quetzal + * `GTQ` - Guatemalan Quetzal - * `GWP` - Guinea-Bissau Peso + * `GWP` - Guinea-Bissau Peso - * `GNF` - Guinean Franc + * `GNF` - Guinean Franc - * `GNS` - Guinean Syli + * `GNS` - Guinean Syli - * `GYD` - Guyanaese Dollar + * `GYD` - Guyanaese Dollar - * `HTG` - Haitian Gourde + * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira + * `HNL` - Honduran Lempira - * `HKD` - Hong Kong Dollar + * `HKD` - Hong Kong Dollar - * `HUF` - Hungarian Forint + * `HUF` - Hungarian Forint - * `IMP` - IMP + * `IMP` - IMP - * `ISK` - Icelandic Króna + * `ISK` - Icelandic Króna - * `ISJ` - Icelandic Króna (1918–1981) + * `ISJ` - Icelandic Króna (1918–1981) - * `INR` - Indian Rupee + * `INR` - Indian Rupee - * `IDR` - Indonesian Rupiah + * `IDR` - Indonesian Rupiah - * `IRR` - Iranian Rial + * `IRR` - Iranian Rial - * `IQD` - Iraqi Dinar + * `IQD` - Iraqi Dinar - * `IEP` - Irish Pound + * `IEP` - Irish Pound - * `ILS` - Israeli New Shekel + * `ILS` - Israeli New Shekel - * `ILP` - Israeli Pound + * `ILP` - Israeli Pound - * `ILR` - Israeli Shekel (1980–1985) + * `ILR` - Israeli Shekel (1980–1985) - * `ITL` - Italian Lira + * `ITL` - Italian Lira - * `JMD` - Jamaican Dollar + * `JMD` - Jamaican Dollar - * `JPY` - Japanese Yen + * `JPY` - Japanese Yen - * `JOD` - Jordanian Dinar + * `JOD` - Jordanian Dinar - * `KZT` - Kazakhstani Tenge + * `KZT` - Kazakhstani Tenge - * `KES` - Kenyan Shilling + * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar + * `KWD` - Kuwaiti Dinar - * `KGS` - Kyrgystani Som + * `KGS` - Kyrgystani Som - * `LAK` - Laotian Kip + * `LAK` - Laotian Kip - * `LVL` - Latvian Lats + * `LVL` - Latvian Lats - * `LVR` - Latvian Ruble + * `LVR` - Latvian Ruble - * `LBP` - Lebanese Pound + * `LBP` - Lebanese Pound - * `LSL` - Lesotho Loti + * `LSL` - Lesotho Loti - * `LRD` - Liberian Dollar + * `LRD` - Liberian Dollar - * `LYD` - Libyan Dinar + * `LYD` - Libyan Dinar - * `LTL` - Lithuanian Litas + * `LTL` - Lithuanian Litas - * `LTT` - Lithuanian Talonas + * `LTT` - Lithuanian Talonas - * `LUL` - Luxembourg Financial Franc + * `LUL` - Luxembourg Financial Franc - * `LUC` - Luxembourgian Convertible Franc + * `LUC` - Luxembourgian Convertible Franc - * `LUF` - Luxembourgian Franc + * `LUF` - Luxembourgian Franc - * `MOP` - Macanese Pataca + * `MOP` - Macanese Pataca - * `MKD` - Macedonian Denar + * `MKD` - Macedonian Denar - * `MKN` - Macedonian Denar (1992–1993) + * `MKN` - Macedonian Denar (1992–1993) - * `MGA` - Malagasy Ariary + * `MGA` - Malagasy Ariary - * `MGF` - Malagasy Franc + * `MGF` - Malagasy Franc - * `MWK` - Malawian Kwacha + * `MWK` - Malawian Kwacha - * `MYR` - Malaysian Ringgit + * `MYR` - Malaysian Ringgit - * `MVR` - Maldivian Rufiyaa + * `MVR` - Maldivian Rufiyaa - * `MVP` - Maldivian Rupee (1947–1981) + * `MVP` - Maldivian Rupee (1947–1981) - * `MLF` - Malian Franc + * `MLF` - Malian Franc - * `MTL` - Maltese Lira + * `MTL` - Maltese Lira - * `MTP` - Maltese Pound + * `MTP` - Maltese Pound - * `MRU` - Mauritanian Ouguiya + * `MRU` - Mauritanian Ouguiya - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MUR` - Mauritian Rupee + * `MUR` - Mauritian Rupee - * `MXV` - Mexican Investment Unit + * `MXV` - Mexican Investment Unit - * `MXN` - Mexican Peso + * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) + * `MXP` - Mexican Silver Peso (1861–1992) - * `MDC` - Moldovan Cupon + * `MDC` - Moldovan Cupon - * `MDL` - Moldovan Leu + * `MDL` - Moldovan Leu - * `MCF` - Monegasque Franc + * `MCF` - Monegasque Franc - * `MNT` - Mongolian Tugrik + * `MNT` - Mongolian Tugrik - * `MAD` - Moroccan Dirham + * `MAD` - Moroccan Dirham - * `MAF` - Moroccan Franc + * `MAF` - Moroccan Franc - * `MZE` - Mozambican Escudo + * `MZE` - Mozambican Escudo - * `MZN` - Mozambican Metical + * `MZN` - Mozambican Metical - * `MZM` - Mozambican Metical (1980–2006) + * `MZM` - Mozambican Metical (1980–2006) - * `MMK` - Myanmar Kyat + * `MMK` - Myanmar Kyat - * `NAD` - Namibian Dollar + * `NAD` - Namibian Dollar - * `NPR` - Nepalese Rupee + * `NPR` - Nepalese Rupee - * `ANG` - Netherlands Antillean Guilder + * `ANG` - Netherlands Antillean Guilder - * `TWD` - New Taiwan Dollar + * `TWD` - New Taiwan Dollar - * `NZD` - New Zealand Dollar + * `NZD` - New Zealand Dollar - * `NIO` - Nicaraguan Córdoba + * `NIO` - Nicaraguan Córdoba - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NGN` - Nigerian Naira + * `NGN` - Nigerian Naira - * `KPW` - North Korean Won + * `KPW` - North Korean Won - * `NOK` - Norwegian Krone + * `NOK` - Norwegian Krone - * `OMR` - Omani Rial + * `OMR` - Omani Rial - * `PKR` - Pakistani Rupee + * `PKR` - Pakistani Rupee - * `XPD` - Palladium + * `XPD` - Palladium - * `PAB` - Panamanian Balboa + * `PAB` - Panamanian Balboa - * `PGK` - Papua New Guinean Kina + * `PGK` - Papua New Guinean Kina - * `PYG` - Paraguayan Guarani + * `PYG` - Paraguayan Guarani - * `PEI` - Peruvian Inti + * `PEI` - Peruvian Inti - * `PEN` - Peruvian Sol + * `PEN` - Peruvian Sol - * `PES` - Peruvian Sol (1863–1965) + * `PES` - Peruvian Sol (1863–1965) - * `PHP` - Philippine Peso + * `PHP` - Philippine Peso - * `XPT` - Platinum + * `XPT` - Platinum - * `PLN` - Polish Zloty + * `PLN` - Polish Zloty - * `PLZ` - Polish Zloty (1950–1995) + * `PLZ` - Polish Zloty (1950–1995) - * `PTE` - Portuguese Escudo + * `PTE` - Portuguese Escudo - * `GWE` - Portuguese Guinea Escudo + * `GWE` - Portuguese Guinea Escudo - * `QAR` - Qatari Rial + * `QAR` - Qatari Rial - * `XRE` - RINET Funds + * `XRE` - RINET Funds - * `RHD` - Rhodesian Dollar + * `RHD` - Rhodesian Dollar - * `RON` - Romanian Leu + * `RON` - Romanian Leu - * `ROL` - Romanian Leu (1952–2006) + * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble + * `RUB` - Russian Ruble - * `RUR` - Russian Ruble (1991–1998) + * `RUR` - Russian Ruble (1991–1998) - * `RWF` - Rwandan Franc + * `RWF` - Rwandan Franc - * `SVC` - Salvadoran Colón + * `SVC` - Salvadoran Colón - * `WST` - Samoan Tala + * `WST` - Samoan Tala - * `SAR` - Saudi Riyal + * `SAR` - Saudi Riyal - * `RSD` - Serbian Dinar + * `RSD` - Serbian Dinar - * `CSD` - Serbian Dinar (2002–2006) + * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee + * `SCR` - Seychellois Rupee - * `SLL` - Sierra Leonean Leone + * `SLL` - Sierra Leonean Leone - * `XAG` - Silver + * `XAG` - Silver - * `SGD` - Singapore Dollar + * `SGD` - Singapore Dollar - * `SKK` - Slovak Koruna + * `SKK` - Slovak Koruna - * `SIT` - Slovenian Tolar + * `SIT` - Slovenian Tolar - * `SBD` - Solomon Islands Dollar + * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling + * `SOS` - Somali Shilling - * `ZAR` - South African Rand + * `ZAR` - South African Rand - * `ZAL` - South African Rand (financial) + * `ZAL` - South African Rand (financial) - * `KRH` - South Korean Hwan (1953–1962) + * `KRH` - South Korean Hwan (1953–1962) - * `KRW` - South Korean Won + * `KRW` - South Korean Won - * `KRO` - South Korean Won (1945–1953) + * `KRO` - South Korean Won (1945–1953) - * `SSP` - South Sudanese Pound + * `SSP` - South Sudanese Pound - * `SUR` - Soviet Rouble + * `SUR` - Soviet Rouble - * `ESP` - Spanish Peseta + * `ESP` - Spanish Peseta - * `ESA` - Spanish Peseta (A account) + * `ESA` - Spanish Peseta (A account) - * `ESB` - Spanish Peseta (convertible account) + * `ESB` - Spanish Peseta (convertible account) - * `XDR` - Special Drawing Rights + * `XDR` - Special Drawing Rights - * `LKR` - Sri Lankan Rupee + * `LKR` - Sri Lankan Rupee - * `SHP` - St. Helena Pound + * `SHP` - St. Helena Pound - * `XSU` - Sucre + * `XSU` - Sucre - * `SDD` - Sudanese Dinar (1992–2007) + * `SDD` - Sudanese Dinar (1992–2007) - * `SDG` - Sudanese Pound + * `SDG` - Sudanese Pound - * `SDP` - Sudanese Pound (1957–1998) + * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar + * `SRD` - Surinamese Dollar - * `SRG` - Surinamese Guilder + * `SRG` - Surinamese Guilder - * `SZL` - Swazi Lilangeni + * `SZL` - Swazi Lilangeni - * `SEK` - Swedish Krona + * `SEK` - Swedish Krona - * `CHF` - Swiss Franc + * `CHF` - Swiss Franc - * `SYP` - Syrian Pound + * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra + * `STN` - São Tomé & Príncipe Dobra - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `TVD` - TVD + * `TVD` - TVD - * `TJR` - Tajikistani Ruble + * `TJR` - Tajikistani Ruble - * `TJS` - Tajikistani Somoni + * `TJS` - Tajikistani Somoni - * `TZS` - Tanzanian Shilling + * `TZS` - Tanzanian Shilling - * `XTS` - Testing Currency Code + * `XTS` - Testing Currency Code - * `THB` - Thai Baht + * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is - involved + * `XXX` - The codes assigned for transactions where no currency is + involved - * `TPE` - Timorese Escudo + * `TPE` - Timorese Escudo - * `TOP` - Tongan Paʻanga + * `TOP` - Tongan Paʻanga - * `TTD` - Trinidad & Tobago Dollar + * `TTD` - Trinidad & Tobago Dollar - * `TND` - Tunisian Dinar + * `TND` - Tunisian Dinar - * `TRY` - Turkish Lira + * `TRY` - Turkish Lira - * `TRL` - Turkish Lira (1922–2005) + * `TRL` - Turkish Lira (1922–2005) - * `TMT` - Turkmenistani Manat + * `TMT` - Turkmenistani Manat - * `TMM` - Turkmenistani Manat (1993–2009) + * `TMM` - Turkmenistani Manat (1993–2009) - * `USD` - US Dollar + * `USD` - US Dollar - * `USN` - US Dollar (Next day) + * `USN` - US Dollar (Next day) - * `USS` - US Dollar (Same day) + * `USS` - US Dollar (Same day) - * `UGX` - Ugandan Shilling + * `UGX` - Ugandan Shilling - * `UGS` - Ugandan Shilling (1966–1987) + * `UGS` - Ugandan Shilling (1966–1987) - * `UAH` - Ukrainian Hryvnia + * `UAH` - Ukrainian Hryvnia - * `UAK` - Ukrainian Karbovanets + * `UAK` - Ukrainian Karbovanets - * `AED` - United Arab Emirates Dirham + * `AED` - United Arab Emirates Dirham - * `UYW` - Uruguayan Nominal Wage Index Unit + * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYU` - Uruguayan Peso + * `UYU` - Uruguayan Peso - * `UYP` - Uruguayan Peso (1975–1993) + * `UYP` - Uruguayan Peso (1975–1993) - * `UYI` - Uruguayan Peso (Indexed Units) + * `UYI` - Uruguayan Peso (Indexed Units) - * `UZS` - Uzbekistani Som + * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu + * `VUV` - Vanuatu Vatu - * `VES` - Venezuelan Bolívar + * `VES` - Venezuelan Bolívar - * `VEB` - Venezuelan Bolívar (1871–2008) + * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEF` - Venezuelan Bolívar (2008–2018) + * `VEF` - Venezuelan Bolívar (2008–2018) - * `VND` - Vietnamese Dong + * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) + * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro + * `CHE` - WIR Euro - * `CHW` - WIR Franc + * `CHW` - WIR Franc - * `XOF` - West African CFA Franc + * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar + * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial + * `YER` - Yemeni Rial - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN + * `ZWN` - ZWN - * `ZRN` - Zairean New Zaire (1993–1998) + * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRZ` - Zairean Zaire (1971–1993) + * `ZRZ` - Zairean Zaire (1971–1993) - * `ZMW` - Zambian Kwacha + * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) + * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWR` - Zimbabwean Dollar (2008) + * `ZWR` - Zimbabwean Dollar (2008) - * `ZWL` - Zimbabwean Dollar (2009) - union: - - TransactionCurrencyEnum - - string + * `ZWL` - Zimbabwean Dollar (2009) + exchange_rate: + type: optional + docs: The expense's exchange rate. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + inclusive_of_tax: + type: optional + docs: >- + If the transaction is inclusive or exclusive of tax. `True` if + inclusive, `False` if exclusive. + company: + type: optional + docs: The company the expense belongs to. + employee: + type: optional + docs: The employee this overall transaction relates to. + memo: + type: optional + docs: The expense's private note. + lines: optional> + tracking_categories: optional>> + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + accounting_period: + type: optional + docs: The accounting period that the Expense was generated in. + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> + access: read-only + remote_fields: + type: optional> + access: read-only source: openapi: openapi/openapi.yml - inline: true - ExpenseLineRequestAccount: + ExpenseLineItem: discriminated: false - docs: The expense's payment account. + docs: The line's item. union: - type: string validation: format: uuid - - Account + - Item source: openapi: openapi/openapi.yml inline: true - ExpenseLineRequestContact: + ExpenseLineTrackingCategory: discriminated: false - docs: The expense's contact. union: - type: string validation: format: uuid - - Contact + - TrackingCategory source: openapi: openapi/openapi.yml inline: true - ExpenseLineRequestProject: + ExpenseLineTrackingCategoriesItem: discriminated: false union: - type: string validation: format: uuid - - Contact + - TrackingCategory source: openapi: openapi/openapi.yml inline: true - ExpenseLineRequest: - docs: |- - # The ExpenseLine Object - ### Description - The `ExpenseLine` object is used to represent an expense's line items. - - ### Usage Example - Fetch from the `GET Expense` endpoint and view the expense's line items. - properties: - remote_id: - type: optional - docs: The third-party API ID of the matching object. - item: - type: optional - docs: The line's item. - net_amount: - type: optional - docs: The line's net amount. - tracking_category: - type: optional - availability: deprecated - tracking_categories: - type: optional>> - docs: The expense line item's associated tracking categories. - company: - type: optional - docs: The company the expense belongs to. + ExpenseLineEmployee: + discriminated: false + docs: The employee this overall transaction relates to. + union: + - type: string validation: format: uuid - employee: - type: optional - docs: The employee this overall transaction relates to. - currency: - type: optional - docs: >- - The expense line item's currency. + - Employee + source: + openapi: openapi/openapi.yml + inline: true + ExpenseLineCurrency: + discriminated: false + docs: >- + The expense line item's currency. - * `XUA` - ADB Unit of Account + * `XUA` - ADB Unit of Account - * `AFN` - Afghan Afghani + * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) + * `AFA` - Afghan Afghani (1927–2002) - * `ALL` - Albanian Lek + * `ALL` - Albanian Lek - * `ALK` - Albanian Lek (1946–1965) + * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar + * `DZD` - Algerian Dinar - * `ADP` - Andorran Peseta + * `ADP` - Andorran Peseta - * `AOA` - Angolan Kwanza + * `AOA` - Angolan Kwanza - * `AOK` - Angolan Kwanza (1977–1991) + * `AOK` - Angolan Kwanza (1977–1991) - * `AON` - Angolan New Kwanza (1990–2000) + * `AON` - Angolan New Kwanza (1990–2000) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `ARA` - Argentine Austral + * `ARA` - Argentine Austral - * `ARS` - Argentine Peso + * `ARS` - Argentine Peso - * `ARM` - Argentine Peso (1881–1970) + * `ARM` - Argentine Peso (1881–1970) - * `ARP` - Argentine Peso (1983–1985) + * `ARP` - Argentine Peso (1983–1985) - * `ARL` - Argentine Peso Ley (1970–1983) + * `ARL` - Argentine Peso Ley (1970–1983) - * `AMD` - Armenian Dram + * `AMD` - Armenian Dram - * `AWG` - Aruban Florin + * `AWG` - Aruban Florin - * `AUD` - Australian Dollar + * `AUD` - Australian Dollar - * `ATS` - Austrian Schilling + * `ATS` - Austrian Schilling - * `AZN` - Azerbaijani Manat + * `AZN` - Azerbaijani Manat - * `AZM` - Azerbaijani Manat (1993–2006) + * `AZM` - Azerbaijani Manat (1993–2006) - * `BSD` - Bahamian Dollar + * `BSD` - Bahamian Dollar - * `BHD` - Bahraini Dinar + * `BHD` - Bahraini Dinar - * `BDT` - Bangladeshi Taka + * `BDT` - Bangladeshi Taka - * `BBD` - Barbadian Dollar + * `BBD` - Barbadian Dollar - * `BYN` - Belarusian Ruble + * `BYN` - Belarusian Ruble - * `BYB` - Belarusian Ruble (1994–1999) + * `BYB` - Belarusian Ruble (1994–1999) - * `BYR` - Belarusian Ruble (2000–2016) + * `BYR` - Belarusian Ruble (2000–2016) - * `BEF` - Belgian Franc + * `BEF` - Belgian Franc - * `BEC` - Belgian Franc (convertible) + * `BEC` - Belgian Franc (convertible) - * `BEL` - Belgian Franc (financial) + * `BEL` - Belgian Franc (financial) - * `BZD` - Belize Dollar + * `BZD` - Belize Dollar - * `BMD` - Bermudan Dollar + * `BMD` - Bermudan Dollar - * `BTN` - Bhutanese Ngultrum + * `BTN` - Bhutanese Ngultrum - * `BOB` - Bolivian Boliviano + * `BOB` - Bolivian Boliviano - * `BOL` - Bolivian Boliviano (1863–1963) + * `BOL` - Bolivian Boliviano (1863–1963) - * `BOV` - Bolivian Mvdol + * `BOV` - Bolivian Mvdol - * `BOP` - Bolivian Peso + * `BOP` - Bolivian Peso - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BWP` - Botswanan Pula + * `BWP` - Botswanan Pula - * `BRC` - Brazilian Cruzado (1986–1989) + * `BRC` - Brazilian Cruzado (1986–1989) - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BRN` - Brazilian New Cruzado (1989–1990) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BRL` - Brazilian Real + * `BRL` - Brazilian Real - * `GBP` - British Pound + * `GBP` - British Pound - * `BND` - Brunei Dollar + * `BND` - Brunei Dollar - * `BGL` - Bulgarian Hard Lev + * `BGL` - Bulgarian Hard Lev - * `BGN` - Bulgarian Lev + * `BGN` - Bulgarian Lev - * `BGO` - Bulgarian Lev (1879–1952) + * `BGO` - Bulgarian Lev (1879–1952) - * `BGM` - Bulgarian Socialist Lev + * `BGM` - Bulgarian Socialist Lev - * `BUK` - Burmese Kyat + * `BUK` - Burmese Kyat - * `BIF` - Burundian Franc + * `BIF` - Burundian Franc - * `XPF` - CFP Franc + * `XPF` - CFP Franc - * `KHR` - Cambodian Riel + * `KHR` - Cambodian Riel - * `CAD` - Canadian Dollar + * `CAD` - Canadian Dollar - * `CVE` - Cape Verdean Escudo + * `CVE` - Cape Verdean Escudo - * `KYD` - Cayman Islands Dollar + * `KYD` - Cayman Islands Dollar - * `XAF` - Central African CFA Franc + * `XAF` - Central African CFA Franc - * `CLE` - Chilean Escudo + * `CLE` - Chilean Escudo - * `CLP` - Chilean Peso + * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) + * `CLF` - Chilean Unit of Account (UF) - * `CNX` - Chinese People’s Bank Dollar + * `CNX` - Chinese People’s Bank Dollar - * `CNY` - Chinese Yuan + * `CNY` - Chinese Yuan - * `CNH` - Chinese Yuan (offshore) + * `CNH` - Chinese Yuan (offshore) - * `COP` - Colombian Peso + * `COP` - Colombian Peso - * `COU` - Colombian Real Value Unit + * `COU` - Colombian Real Value Unit - * `KMF` - Comorian Franc + * `KMF` - Comorian Franc - * `CDF` - Congolese Franc + * `CDF` - Congolese Franc - * `CRC` - Costa Rican Colón + * `CRC` - Costa Rican Colón - * `HRD` - Croatian Dinar + * `HRD` - Croatian Dinar - * `HRK` - Croatian Kuna + * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso + * `CUC` - Cuban Convertible Peso - * `CUP` - Cuban Peso + * `CUP` - Cuban Peso - * `CYP` - Cypriot Pound + * `CYP` - Cypriot Pound - * `CZK` - Czech Koruna + * `CZK` - Czech Koruna - * `CSK` - Czechoslovak Hard Koruna + * `CSK` - Czechoslovak Hard Koruna - * `DKK` - Danish Krone + * `DKK` - Danish Krone - * `DJF` - Djiboutian Franc + * `DJF` - Djiboutian Franc - * `DOP` - Dominican Peso + * `DOP` - Dominican Peso - * `NLG` - Dutch Guilder + * `NLG` - Dutch Guilder - * `XCD` - East Caribbean Dollar + * `XCD` - East Caribbean Dollar - * `DDM` - East German Mark + * `DDM` - East German Mark - * `ECS` - Ecuadorian Sucre + * `ECS` - Ecuadorian Sucre - * `ECV` - Ecuadorian Unit of Constant Value + * `ECV` - Ecuadorian Unit of Constant Value - * `EGP` - Egyptian Pound + * `EGP` - Egyptian Pound - * `GQE` - Equatorial Guinean Ekwele + * `GQE` - Equatorial Guinean Ekwele - * `ERN` - Eritrean Nakfa + * `ERN` - Eritrean Nakfa - * `EEK` - Estonian Kroon + * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr + * `ETB` - Ethiopian Birr - * `EUR` - Euro + * `EUR` - Euro - * `XBA` - European Composite Unit + * `XBA` - European Composite Unit - * `XEU` - European Currency Unit + * `XEU` - European Currency Unit - * `XBB` - European Monetary Unit + * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) + * `XBC` - European Unit of Account (XBC) - * `XBD` - European Unit of Account (XBD) + * `XBD` - European Unit of Account (XBD) - * `FKP` - Falkland Islands Pound + * `FKP` - Falkland Islands Pound - * `FJD` - Fijian Dollar + * `FJD` - Fijian Dollar - * `FIM` - Finnish Markka + * `FIM` - Finnish Markka - * `FRF` - French Franc + * `FRF` - French Franc - * `XFO` - French Gold Franc + * `XFO` - French Gold Franc - * `XFU` - French UIC-Franc + * `XFU` - French UIC-Franc - * `GMD` - Gambian Dalasi + * `GMD` - Gambian Dalasi - * `GEK` - Georgian Kupon Larit + * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari + * `GEL` - Georgian Lari - * `DEM` - German Mark + * `DEM` - German Mark - * `GHS` - Ghanaian Cedi + * `GHS` - Ghanaian Cedi - * `GHC` - Ghanaian Cedi (1979–2007) + * `GHC` - Ghanaian Cedi (1979–2007) - * `GIP` - Gibraltar Pound + * `GIP` - Gibraltar Pound - * `XAU` - Gold + * `XAU` - Gold - * `GRD` - Greek Drachma + * `GRD` - Greek Drachma - * `GTQ` - Guatemalan Quetzal + * `GTQ` - Guatemalan Quetzal - * `GWP` - Guinea-Bissau Peso + * `GWP` - Guinea-Bissau Peso - * `GNF` - Guinean Franc + * `GNF` - Guinean Franc - * `GNS` - Guinean Syli + * `GNS` - Guinean Syli - * `GYD` - Guyanaese Dollar + * `GYD` - Guyanaese Dollar - * `HTG` - Haitian Gourde + * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira + * `HNL` - Honduran Lempira - * `HKD` - Hong Kong Dollar + * `HKD` - Hong Kong Dollar - * `HUF` - Hungarian Forint + * `HUF` - Hungarian Forint - * `IMP` - IMP + * `IMP` - IMP - * `ISK` - Icelandic Króna + * `ISK` - Icelandic Króna - * `ISJ` - Icelandic Króna (1918–1981) + * `ISJ` - Icelandic Króna (1918–1981) - * `INR` - Indian Rupee + * `INR` - Indian Rupee - * `IDR` - Indonesian Rupiah + * `IDR` - Indonesian Rupiah - * `IRR` - Iranian Rial + * `IRR` - Iranian Rial - * `IQD` - Iraqi Dinar + * `IQD` - Iraqi Dinar - * `IEP` - Irish Pound + * `IEP` - Irish Pound - * `ILS` - Israeli New Shekel + * `ILS` - Israeli New Shekel - * `ILP` - Israeli Pound + * `ILP` - Israeli Pound - * `ILR` - Israeli Shekel (1980–1985) + * `ILR` - Israeli Shekel (1980–1985) - * `ITL` - Italian Lira + * `ITL` - Italian Lira - * `JMD` - Jamaican Dollar + * `JMD` - Jamaican Dollar - * `JPY` - Japanese Yen + * `JPY` - Japanese Yen - * `JOD` - Jordanian Dinar + * `JOD` - Jordanian Dinar - * `KZT` - Kazakhstani Tenge + * `KZT` - Kazakhstani Tenge - * `KES` - Kenyan Shilling + * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar + * `KWD` - Kuwaiti Dinar - * `KGS` - Kyrgystani Som + * `KGS` - Kyrgystani Som - * `LAK` - Laotian Kip + * `LAK` - Laotian Kip - * `LVL` - Latvian Lats + * `LVL` - Latvian Lats - * `LVR` - Latvian Ruble + * `LVR` - Latvian Ruble - * `LBP` - Lebanese Pound + * `LBP` - Lebanese Pound - * `LSL` - Lesotho Loti + * `LSL` - Lesotho Loti - * `LRD` - Liberian Dollar + * `LRD` - Liberian Dollar - * `LYD` - Libyan Dinar + * `LYD` - Libyan Dinar - * `LTL` - Lithuanian Litas + * `LTL` - Lithuanian Litas - * `LTT` - Lithuanian Talonas + * `LTT` - Lithuanian Talonas - * `LUL` - Luxembourg Financial Franc + * `LUL` - Luxembourg Financial Franc - * `LUC` - Luxembourgian Convertible Franc + * `LUC` - Luxembourgian Convertible Franc - * `LUF` - Luxembourgian Franc + * `LUF` - Luxembourgian Franc - * `MOP` - Macanese Pataca + * `MOP` - Macanese Pataca - * `MKD` - Macedonian Denar + * `MKD` - Macedonian Denar - * `MKN` - Macedonian Denar (1992–1993) + * `MKN` - Macedonian Denar (1992–1993) - * `MGA` - Malagasy Ariary + * `MGA` - Malagasy Ariary - * `MGF` - Malagasy Franc + * `MGF` - Malagasy Franc - * `MWK` - Malawian Kwacha + * `MWK` - Malawian Kwacha - * `MYR` - Malaysian Ringgit + * `MYR` - Malaysian Ringgit - * `MVR` - Maldivian Rufiyaa + * `MVR` - Maldivian Rufiyaa - * `MVP` - Maldivian Rupee (1947–1981) + * `MVP` - Maldivian Rupee (1947–1981) - * `MLF` - Malian Franc + * `MLF` - Malian Franc - * `MTL` - Maltese Lira + * `MTL` - Maltese Lira - * `MTP` - Maltese Pound + * `MTP` - Maltese Pound - * `MRU` - Mauritanian Ouguiya + * `MRU` - Mauritanian Ouguiya - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MUR` - Mauritian Rupee + * `MUR` - Mauritian Rupee - * `MXV` - Mexican Investment Unit + * `MXV` - Mexican Investment Unit - * `MXN` - Mexican Peso + * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) + * `MXP` - Mexican Silver Peso (1861–1992) - * `MDC` - Moldovan Cupon + * `MDC` - Moldovan Cupon - * `MDL` - Moldovan Leu + * `MDL` - Moldovan Leu - * `MCF` - Monegasque Franc + * `MCF` - Monegasque Franc - * `MNT` - Mongolian Tugrik + * `MNT` - Mongolian Tugrik - * `MAD` - Moroccan Dirham + * `MAD` - Moroccan Dirham - * `MAF` - Moroccan Franc + * `MAF` - Moroccan Franc - * `MZE` - Mozambican Escudo + * `MZE` - Mozambican Escudo - * `MZN` - Mozambican Metical + * `MZN` - Mozambican Metical - * `MZM` - Mozambican Metical (1980–2006) + * `MZM` - Mozambican Metical (1980–2006) - * `MMK` - Myanmar Kyat + * `MMK` - Myanmar Kyat - * `NAD` - Namibian Dollar + * `NAD` - Namibian Dollar - * `NPR` - Nepalese Rupee + * `NPR` - Nepalese Rupee - * `ANG` - Netherlands Antillean Guilder + * `ANG` - Netherlands Antillean Guilder - * `TWD` - New Taiwan Dollar + * `TWD` - New Taiwan Dollar - * `NZD` - New Zealand Dollar + * `NZD` - New Zealand Dollar - * `NIO` - Nicaraguan Córdoba + * `NIO` - Nicaraguan Córdoba - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NGN` - Nigerian Naira + * `NGN` - Nigerian Naira - * `KPW` - North Korean Won + * `KPW` - North Korean Won - * `NOK` - Norwegian Krone + * `NOK` - Norwegian Krone - * `OMR` - Omani Rial + * `OMR` - Omani Rial - * `PKR` - Pakistani Rupee + * `PKR` - Pakistani Rupee - * `XPD` - Palladium + * `XPD` - Palladium - * `PAB` - Panamanian Balboa + * `PAB` - Panamanian Balboa - * `PGK` - Papua New Guinean Kina + * `PGK` - Papua New Guinean Kina - * `PYG` - Paraguayan Guarani + * `PYG` - Paraguayan Guarani - * `PEI` - Peruvian Inti + * `PEI` - Peruvian Inti - * `PEN` - Peruvian Sol + * `PEN` - Peruvian Sol - * `PES` - Peruvian Sol (1863–1965) + * `PES` - Peruvian Sol (1863–1965) - * `PHP` - Philippine Peso + * `PHP` - Philippine Peso - * `XPT` - Platinum + * `XPT` - Platinum - * `PLN` - Polish Zloty + * `PLN` - Polish Zloty - * `PLZ` - Polish Zloty (1950–1995) + * `PLZ` - Polish Zloty (1950–1995) - * `PTE` - Portuguese Escudo + * `PTE` - Portuguese Escudo - * `GWE` - Portuguese Guinea Escudo + * `GWE` - Portuguese Guinea Escudo - * `QAR` - Qatari Rial + * `QAR` - Qatari Rial - * `XRE` - RINET Funds + * `XRE` - RINET Funds - * `RHD` - Rhodesian Dollar + * `RHD` - Rhodesian Dollar - * `RON` - Romanian Leu + * `RON` - Romanian Leu - * `ROL` - Romanian Leu (1952–2006) + * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble + * `RUB` - Russian Ruble - * `RUR` - Russian Ruble (1991–1998) + * `RUR` - Russian Ruble (1991–1998) - * `RWF` - Rwandan Franc + * `RWF` - Rwandan Franc - * `SVC` - Salvadoran Colón + * `SVC` - Salvadoran Colón - * `WST` - Samoan Tala + * `WST` - Samoan Tala - * `SAR` - Saudi Riyal + * `SAR` - Saudi Riyal - * `RSD` - Serbian Dinar + * `RSD` - Serbian Dinar - * `CSD` - Serbian Dinar (2002–2006) + * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee + * `SCR` - Seychellois Rupee - * `SLL` - Sierra Leonean Leone + * `SLL` - Sierra Leonean Leone - * `XAG` - Silver + * `XAG` - Silver - * `SGD` - Singapore Dollar + * `SGD` - Singapore Dollar - * `SKK` - Slovak Koruna + * `SKK` - Slovak Koruna - * `SIT` - Slovenian Tolar + * `SIT` - Slovenian Tolar - * `SBD` - Solomon Islands Dollar + * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling + * `SOS` - Somali Shilling - * `ZAR` - South African Rand + * `ZAR` - South African Rand - * `ZAL` - South African Rand (financial) + * `ZAL` - South African Rand (financial) - * `KRH` - South Korean Hwan (1953–1962) + * `KRH` - South Korean Hwan (1953–1962) - * `KRW` - South Korean Won + * `KRW` - South Korean Won - * `KRO` - South Korean Won (1945–1953) + * `KRO` - South Korean Won (1945–1953) - * `SSP` - South Sudanese Pound + * `SSP` - South Sudanese Pound - * `SUR` - Soviet Rouble + * `SUR` - Soviet Rouble - * `ESP` - Spanish Peseta + * `ESP` - Spanish Peseta - * `ESA` - Spanish Peseta (A account) + * `ESA` - Spanish Peseta (A account) - * `ESB` - Spanish Peseta (convertible account) + * `ESB` - Spanish Peseta (convertible account) - * `XDR` - Special Drawing Rights + * `XDR` - Special Drawing Rights - * `LKR` - Sri Lankan Rupee + * `LKR` - Sri Lankan Rupee - * `SHP` - St. Helena Pound + * `SHP` - St. Helena Pound - * `XSU` - Sucre + * `XSU` - Sucre - * `SDD` - Sudanese Dinar (1992–2007) + * `SDD` - Sudanese Dinar (1992–2007) - * `SDG` - Sudanese Pound + * `SDG` - Sudanese Pound - * `SDP` - Sudanese Pound (1957–1998) + * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar + * `SRD` - Surinamese Dollar - * `SRG` - Surinamese Guilder + * `SRG` - Surinamese Guilder - * `SZL` - Swazi Lilangeni + * `SZL` - Swazi Lilangeni - * `SEK` - Swedish Krona + * `SEK` - Swedish Krona - * `CHF` - Swiss Franc + * `CHF` - Swiss Franc - * `SYP` - Syrian Pound + * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra + * `STN` - São Tomé & Príncipe Dobra - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `TVD` - TVD + * `TVD` - TVD - * `TJR` - Tajikistani Ruble + * `TJR` - Tajikistani Ruble - * `TJS` - Tajikistani Somoni + * `TJS` - Tajikistani Somoni - * `TZS` - Tanzanian Shilling + * `TZS` - Tanzanian Shilling - * `XTS` - Testing Currency Code + * `XTS` - Testing Currency Code - * `THB` - Thai Baht + * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is - involved + * `XXX` - The codes assigned for transactions where no currency is + involved - * `TPE` - Timorese Escudo + * `TPE` - Timorese Escudo - * `TOP` - Tongan Paʻanga + * `TOP` - Tongan Paʻanga - * `TTD` - Trinidad & Tobago Dollar + * `TTD` - Trinidad & Tobago Dollar - * `TND` - Tunisian Dinar + * `TND` - Tunisian Dinar - * `TRY` - Turkish Lira + * `TRY` - Turkish Lira - * `TRL` - Turkish Lira (1922–2005) + * `TRL` - Turkish Lira (1922–2005) - * `TMT` - Turkmenistani Manat + * `TMT` - Turkmenistani Manat - * `TMM` - Turkmenistani Manat (1993–2009) + * `TMM` - Turkmenistani Manat (1993–2009) - * `USD` - US Dollar + * `USD` - US Dollar - * `USN` - US Dollar (Next day) + * `USN` - US Dollar (Next day) - * `USS` - US Dollar (Same day) + * `USS` - US Dollar (Same day) - * `UGX` - Ugandan Shilling + * `UGX` - Ugandan Shilling - * `UGS` - Ugandan Shilling (1966–1987) + * `UGS` - Ugandan Shilling (1966–1987) - * `UAH` - Ukrainian Hryvnia + * `UAH` - Ukrainian Hryvnia - * `UAK` - Ukrainian Karbovanets + * `UAK` - Ukrainian Karbovanets - * `AED` - United Arab Emirates Dirham + * `AED` - United Arab Emirates Dirham - * `UYW` - Uruguayan Nominal Wage Index Unit + * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYU` - Uruguayan Peso + * `UYU` - Uruguayan Peso - * `UYP` - Uruguayan Peso (1975–1993) + * `UYP` - Uruguayan Peso (1975–1993) - * `UYI` - Uruguayan Peso (Indexed Units) + * `UYI` - Uruguayan Peso (Indexed Units) - * `UZS` - Uzbekistani Som + * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu + * `VUV` - Vanuatu Vatu - * `VES` - Venezuelan Bolívar + * `VES` - Venezuelan Bolívar - * `VEB` - Venezuelan Bolívar (1871–2008) + * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEF` - Venezuelan Bolívar (2008–2018) + * `VEF` - Venezuelan Bolívar (2008–2018) - * `VND` - Vietnamese Dong + * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) + * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro + * `CHE` - WIR Euro - * `CHW` - WIR Franc + * `CHW` - WIR Franc - * `XOF` - West African CFA Franc + * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar + * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial + * `YER` - Yemeni Rial - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN + * `ZWN` - ZWN - * `ZRN` - Zairean New Zaire (1993–1998) + * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRZ` - Zairean Zaire (1971–1993) + * `ZRZ` - Zairean Zaire (1971–1993) - * `ZMW` - Zambian Kwacha + * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) + * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWR` - Zimbabwean Dollar (2008) + * `ZWR` - Zimbabwean Dollar (2008) - * `ZWL` - Zimbabwean Dollar (2009) - account: - type: optional - docs: The expense's payment account. - contact: - type: optional - docs: The expense's contact. - project: optional - description: - type: optional - docs: The description of the item that was purchased by the company. - exchange_rate: - type: optional - docs: The expense line item's exchange rate. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - tax_rate: - type: optional - docs: The tax rate that applies to this line item. + * `ZWL` - Zimbabwean Dollar (2009) + union: + - TransactionCurrencyEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + ExpenseLineAccount: + discriminated: false + docs: The expense's payment account. + union: + - type: string validation: format: uuid - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - remote_fields: - type: optional> - access: write-only + - Account source: openapi: openapi/openapi.yml - ExpenseReportStatus: + inline: true + ExpenseLineContact: discriminated: false - docs: >- - Overall status of the expense report. One of DRAFT, SUBMITTED, APPROVED, - REJECTED - - - * `DRAFT` - DRAFT - - * `SUBMITTED` - SUBMITTED - - * `APPROVED` - APPROVED - - * `REJECTED` - REJECTED + docs: The expense's contact. union: - - ExpenseReportStatusEnum - - string + - type: string + validation: + format: uuid + - Contact source: openapi: openapi/openapi.yml inline: true - ExpenseReportCompany: + ExpenseLineProject: discriminated: false - docs: The subsidiary that the expense report is created in union: - type: string validation: format: uuid - - CompanyInfo + - Project source: openapi: openapi/openapi.yml inline: true - ExpenseReport: - docs: >- - # The ExpenseReport Object - + ExpenseLine: + docs: |- + # The ExpenseLine Object ### Description - - The `ExpenseReport` object represents a collection of expenses submitted - for review and reimbursement. - - It includes details about the submitter, status, amounts, and associated - metadata. - + The `ExpenseLine` object is used to represent an expense's line items. ### Usage Example - - Fetch from the `GET ExpenseReport` endpoint to view details of expense - reports and their line items. + Fetch from the `GET Expense` endpoint and view the expense's line items. properties: id: type: optional @@ -20488,45 +15893,30 @@ types: type: optional docs: The datetime that this object was modified by Merge. access: read-only - report_date: - type: optional - docs: The date of the expense report. - report_identifier: - type: optional - docs: Human-readable expense report identifier. - validation: - maxLength: 1024 - employee: + item: + type: optional + docs: The line's item. + net_amount: + type: optional + docs: The line's net amount. + tracking_category: + type: optional + availability: deprecated + tracking_categories: + type: optional>> + docs: The expense line item's associated tracking categories. + company: type: optional - docs: >- - Identifier for the employee who submitted or is associated with the - expense report + docs: The company the expense belongs to. validation: format: uuid - status: - type: optional - docs: >- - Overall status of the expense report. One of DRAFT, SUBMITTED, - APPROVED, REJECTED - - - * `DRAFT` - DRAFT - - * `SUBMITTED` - SUBMITTED - - * `APPROVED` - APPROVED - - * `REJECTED` - REJECTED - total_amount: - type: optional - docs: Total amount of the expense report - lines: - type: optional> - access: read-only + employee: + type: optional + docs: The employee this overall transaction relates to. currency: - type: optional + type: optional docs: >- - Currency code for the expense report + The expense line item's currency. * `XUA` - ADB Unit of Account @@ -21141,22 +16531,26 @@ types: * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) + account: + type: optional + docs: The expense's payment account. + contact: + type: optional + docs: The expense's contact. + project: optional description: type: optional - docs: A brief description or purpose for the expense report + docs: The description of the item that was purchased by the company. + exchange_rate: + type: optional + docs: The expense line item's exchange rate. validation: - maxLength: 1024 - accounting_period: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + tax_rate: type: optional - docs: The accounting period the report was posted in + docs: The tax rate that applies to this line item. validation: format: uuid - company: - type: optional - docs: The subsidiary that the expense report is created in - tracking_categories: - docs: The related tracking categories associated with the expense report - type: list remote_was_deleted: type: optional docs: >- @@ -21166,845 +16560,688 @@ types: [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). access: read-only - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - remote_fields: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - ExpenseReportLineAccount: - discriminated: false - union: - - type: string - validation: - format: uuid - - Account source: openapi: openapi/openapi.yml - inline: true - ExpenseReportLineEmployee: + ExpenseLineRequestItem: discriminated: false - docs: >- - Identifier for the employee who submitted or is associated with the - expense report + docs: The line's item. union: - type: string validation: format: uuid - - Employee + - Item source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineProject: + ExpenseLineRequestTrackingCategory: discriminated: false union: - type: string validation: format: uuid - - Project + - TrackingCategory source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineCompany: + ExpenseLineRequestTrackingCategoriesItem: discriminated: false - docs: The subsidiary that the expense report is created in union: - type: string validation: format: uuid - - CompanyInfo + - TrackingCategory source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineContact: + ExpenseLineRequestEmployee: discriminated: false + docs: The employee this overall transaction relates to. union: - type: string validation: format: uuid - - Contact + - Employee source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineTaxRate: + ExpenseLineRequestCurrency: discriminated: false - union: - - type: string - validation: - format: uuid - - TaxRate - source: - openapi: openapi/openapi.yml - inline: true - ExpenseReportLine: docs: >- - # The ExpenseReportLine Object - - ### Description - - The `ExpenseReportLine` object represents an individual line item within - an expense report, containing details about - - a specific expense such as amount, description, and associated metadata. - - - ### Usage Example - - Fetch from the `GET ExpenseReport` endpoint and expand the lines field to - view all line items in the expense report. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - account: optional - description: - type: optional - docs: Description of the individual expense. - validation: - maxLength: 1024 - expense_date: - type: optional - docs: The date the individual expense was incurred. - amount: - type: optional - docs: The amount of the expense for the line item. - currency: - type: optional - docs: >- - Currency of the expense line (if different from the report currency). + The expense line item's currency. - * `XUA` - ADB Unit of Account + * `XUA` - ADB Unit of Account - * `AFN` - Afghan Afghani + * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) + * `AFA` - Afghan Afghani (1927–2002) - * `ALL` - Albanian Lek + * `ALL` - Albanian Lek - * `ALK` - Albanian Lek (1946–1965) + * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar + * `DZD` - Algerian Dinar - * `ADP` - Andorran Peseta + * `ADP` - Andorran Peseta - * `AOA` - Angolan Kwanza + * `AOA` - Angolan Kwanza - * `AOK` - Angolan Kwanza (1977–1991) + * `AOK` - Angolan Kwanza (1977–1991) - * `AON` - Angolan New Kwanza (1990–2000) + * `AON` - Angolan New Kwanza (1990–2000) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `ARA` - Argentine Austral + * `ARA` - Argentine Austral - * `ARS` - Argentine Peso + * `ARS` - Argentine Peso - * `ARM` - Argentine Peso (1881–1970) + * `ARM` - Argentine Peso (1881–1970) - * `ARP` - Argentine Peso (1983–1985) + * `ARP` - Argentine Peso (1983–1985) - * `ARL` - Argentine Peso Ley (1970–1983) + * `ARL` - Argentine Peso Ley (1970–1983) - * `AMD` - Armenian Dram + * `AMD` - Armenian Dram - * `AWG` - Aruban Florin + * `AWG` - Aruban Florin - * `AUD` - Australian Dollar + * `AUD` - Australian Dollar - * `ATS` - Austrian Schilling + * `ATS` - Austrian Schilling - * `AZN` - Azerbaijani Manat + * `AZN` - Azerbaijani Manat - * `AZM` - Azerbaijani Manat (1993–2006) + * `AZM` - Azerbaijani Manat (1993–2006) - * `BSD` - Bahamian Dollar + * `BSD` - Bahamian Dollar - * `BHD` - Bahraini Dinar + * `BHD` - Bahraini Dinar - * `BDT` - Bangladeshi Taka + * `BDT` - Bangladeshi Taka - * `BBD` - Barbadian Dollar + * `BBD` - Barbadian Dollar - * `BYN` - Belarusian Ruble + * `BYN` - Belarusian Ruble - * `BYB` - Belarusian Ruble (1994–1999) + * `BYB` - Belarusian Ruble (1994–1999) - * `BYR` - Belarusian Ruble (2000–2016) + * `BYR` - Belarusian Ruble (2000–2016) - * `BEF` - Belgian Franc + * `BEF` - Belgian Franc - * `BEC` - Belgian Franc (convertible) + * `BEC` - Belgian Franc (convertible) - * `BEL` - Belgian Franc (financial) + * `BEL` - Belgian Franc (financial) - * `BZD` - Belize Dollar + * `BZD` - Belize Dollar - * `BMD` - Bermudan Dollar + * `BMD` - Bermudan Dollar - * `BTN` - Bhutanese Ngultrum + * `BTN` - Bhutanese Ngultrum - * `BOB` - Bolivian Boliviano + * `BOB` - Bolivian Boliviano - * `BOL` - Bolivian Boliviano (1863–1963) + * `BOL` - Bolivian Boliviano (1863–1963) - * `BOV` - Bolivian Mvdol + * `BOV` - Bolivian Mvdol - * `BOP` - Bolivian Peso + * `BOP` - Bolivian Peso - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BWP` - Botswanan Pula + * `BWP` - Botswanan Pula - * `BRC` - Brazilian Cruzado (1986–1989) + * `BRC` - Brazilian Cruzado (1986–1989) - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BRN` - Brazilian New Cruzado (1989–1990) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BRL` - Brazilian Real + * `BRL` - Brazilian Real - * `GBP` - British Pound + * `GBP` - British Pound - * `BND` - Brunei Dollar + * `BND` - Brunei Dollar - * `BGL` - Bulgarian Hard Lev + * `BGL` - Bulgarian Hard Lev - * `BGN` - Bulgarian Lev + * `BGN` - Bulgarian Lev - * `BGO` - Bulgarian Lev (1879–1952) + * `BGO` - Bulgarian Lev (1879–1952) - * `BGM` - Bulgarian Socialist Lev + * `BGM` - Bulgarian Socialist Lev - * `BUK` - Burmese Kyat + * `BUK` - Burmese Kyat - * `BIF` - Burundian Franc + * `BIF` - Burundian Franc - * `XPF` - CFP Franc + * `XPF` - CFP Franc - * `KHR` - Cambodian Riel + * `KHR` - Cambodian Riel - * `CAD` - Canadian Dollar + * `CAD` - Canadian Dollar - * `CVE` - Cape Verdean Escudo + * `CVE` - Cape Verdean Escudo - * `KYD` - Cayman Islands Dollar + * `KYD` - Cayman Islands Dollar - * `XAF` - Central African CFA Franc + * `XAF` - Central African CFA Franc - * `CLE` - Chilean Escudo + * `CLE` - Chilean Escudo - * `CLP` - Chilean Peso + * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) + * `CLF` - Chilean Unit of Account (UF) - * `CNX` - Chinese People’s Bank Dollar + * `CNX` - Chinese People’s Bank Dollar - * `CNY` - Chinese Yuan + * `CNY` - Chinese Yuan - * `CNH` - Chinese Yuan (offshore) + * `CNH` - Chinese Yuan (offshore) - * `COP` - Colombian Peso + * `COP` - Colombian Peso - * `COU` - Colombian Real Value Unit + * `COU` - Colombian Real Value Unit - * `KMF` - Comorian Franc + * `KMF` - Comorian Franc - * `CDF` - Congolese Franc + * `CDF` - Congolese Franc - * `CRC` - Costa Rican Colón + * `CRC` - Costa Rican Colón - * `HRD` - Croatian Dinar + * `HRD` - Croatian Dinar - * `HRK` - Croatian Kuna + * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso + * `CUC` - Cuban Convertible Peso - * `CUP` - Cuban Peso + * `CUP` - Cuban Peso - * `CYP` - Cypriot Pound + * `CYP` - Cypriot Pound - * `CZK` - Czech Koruna + * `CZK` - Czech Koruna - * `CSK` - Czechoslovak Hard Koruna + * `CSK` - Czechoslovak Hard Koruna - * `DKK` - Danish Krone + * `DKK` - Danish Krone - * `DJF` - Djiboutian Franc + * `DJF` - Djiboutian Franc - * `DOP` - Dominican Peso + * `DOP` - Dominican Peso - * `NLG` - Dutch Guilder + * `NLG` - Dutch Guilder - * `XCD` - East Caribbean Dollar + * `XCD` - East Caribbean Dollar - * `DDM` - East German Mark + * `DDM` - East German Mark - * `ECS` - Ecuadorian Sucre + * `ECS` - Ecuadorian Sucre - * `ECV` - Ecuadorian Unit of Constant Value + * `ECV` - Ecuadorian Unit of Constant Value - * `EGP` - Egyptian Pound + * `EGP` - Egyptian Pound - * `GQE` - Equatorial Guinean Ekwele + * `GQE` - Equatorial Guinean Ekwele - * `ERN` - Eritrean Nakfa + * `ERN` - Eritrean Nakfa - * `EEK` - Estonian Kroon + * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr + * `ETB` - Ethiopian Birr - * `EUR` - Euro + * `EUR` - Euro - * `XBA` - European Composite Unit + * `XBA` - European Composite Unit - * `XEU` - European Currency Unit + * `XEU` - European Currency Unit - * `XBB` - European Monetary Unit + * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) + * `XBC` - European Unit of Account (XBC) - * `XBD` - European Unit of Account (XBD) + * `XBD` - European Unit of Account (XBD) - * `FKP` - Falkland Islands Pound + * `FKP` - Falkland Islands Pound - * `FJD` - Fijian Dollar + * `FJD` - Fijian Dollar - * `FIM` - Finnish Markka + * `FIM` - Finnish Markka - * `FRF` - French Franc + * `FRF` - French Franc - * `XFO` - French Gold Franc + * `XFO` - French Gold Franc - * `XFU` - French UIC-Franc + * `XFU` - French UIC-Franc - * `GMD` - Gambian Dalasi + * `GMD` - Gambian Dalasi - * `GEK` - Georgian Kupon Larit + * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari + * `GEL` - Georgian Lari - * `DEM` - German Mark + * `DEM` - German Mark - * `GHS` - Ghanaian Cedi + * `GHS` - Ghanaian Cedi - * `GHC` - Ghanaian Cedi (1979–2007) + * `GHC` - Ghanaian Cedi (1979–2007) - * `GIP` - Gibraltar Pound + * `GIP` - Gibraltar Pound - * `XAU` - Gold + * `XAU` - Gold - * `GRD` - Greek Drachma + * `GRD` - Greek Drachma - * `GTQ` - Guatemalan Quetzal + * `GTQ` - Guatemalan Quetzal - * `GWP` - Guinea-Bissau Peso + * `GWP` - Guinea-Bissau Peso - * `GNF` - Guinean Franc + * `GNF` - Guinean Franc - * `GNS` - Guinean Syli + * `GNS` - Guinean Syli - * `GYD` - Guyanaese Dollar + * `GYD` - Guyanaese Dollar - * `HTG` - Haitian Gourde + * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira + * `HNL` - Honduran Lempira - * `HKD` - Hong Kong Dollar + * `HKD` - Hong Kong Dollar - * `HUF` - Hungarian Forint + * `HUF` - Hungarian Forint - * `IMP` - IMP + * `IMP` - IMP - * `ISK` - Icelandic Króna + * `ISK` - Icelandic Króna - * `ISJ` - Icelandic Króna (1918–1981) + * `ISJ` - Icelandic Króna (1918–1981) - * `INR` - Indian Rupee + * `INR` - Indian Rupee - * `IDR` - Indonesian Rupiah + * `IDR` - Indonesian Rupiah - * `IRR` - Iranian Rial + * `IRR` - Iranian Rial - * `IQD` - Iraqi Dinar + * `IQD` - Iraqi Dinar - * `IEP` - Irish Pound + * `IEP` - Irish Pound - * `ILS` - Israeli New Shekel + * `ILS` - Israeli New Shekel - * `ILP` - Israeli Pound + * `ILP` - Israeli Pound - * `ILR` - Israeli Shekel (1980–1985) + * `ILR` - Israeli Shekel (1980–1985) - * `ITL` - Italian Lira + * `ITL` - Italian Lira - * `JMD` - Jamaican Dollar + * `JMD` - Jamaican Dollar - * `JPY` - Japanese Yen + * `JPY` - Japanese Yen - * `JOD` - Jordanian Dinar + * `JOD` - Jordanian Dinar - * `KZT` - Kazakhstani Tenge + * `KZT` - Kazakhstani Tenge - * `KES` - Kenyan Shilling + * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar + * `KWD` - Kuwaiti Dinar - * `KGS` - Kyrgystani Som + * `KGS` - Kyrgystani Som - * `LAK` - Laotian Kip + * `LAK` - Laotian Kip - * `LVL` - Latvian Lats + * `LVL` - Latvian Lats - * `LVR` - Latvian Ruble + * `LVR` - Latvian Ruble - * `LBP` - Lebanese Pound + * `LBP` - Lebanese Pound - * `LSL` - Lesotho Loti + * `LSL` - Lesotho Loti - * `LRD` - Liberian Dollar + * `LRD` - Liberian Dollar - * `LYD` - Libyan Dinar + * `LYD` - Libyan Dinar - * `LTL` - Lithuanian Litas + * `LTL` - Lithuanian Litas - * `LTT` - Lithuanian Talonas + * `LTT` - Lithuanian Talonas - * `LUL` - Luxembourg Financial Franc + * `LUL` - Luxembourg Financial Franc - * `LUC` - Luxembourgian Convertible Franc + * `LUC` - Luxembourgian Convertible Franc - * `LUF` - Luxembourgian Franc + * `LUF` - Luxembourgian Franc - * `MOP` - Macanese Pataca + * `MOP` - Macanese Pataca - * `MKD` - Macedonian Denar + * `MKD` - Macedonian Denar - * `MKN` - Macedonian Denar (1992–1993) + * `MKN` - Macedonian Denar (1992–1993) - * `MGA` - Malagasy Ariary + * `MGA` - Malagasy Ariary - * `MGF` - Malagasy Franc + * `MGF` - Malagasy Franc - * `MWK` - Malawian Kwacha + * `MWK` - Malawian Kwacha - * `MYR` - Malaysian Ringgit + * `MYR` - Malaysian Ringgit - * `MVR` - Maldivian Rufiyaa + * `MVR` - Maldivian Rufiyaa - * `MVP` - Maldivian Rupee (1947–1981) + * `MVP` - Maldivian Rupee (1947–1981) - * `MLF` - Malian Franc + * `MLF` - Malian Franc - * `MTL` - Maltese Lira + * `MTL` - Maltese Lira - * `MTP` - Maltese Pound + * `MTP` - Maltese Pound - * `MRU` - Mauritanian Ouguiya + * `MRU` - Mauritanian Ouguiya - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MUR` - Mauritian Rupee + * `MUR` - Mauritian Rupee - * `MXV` - Mexican Investment Unit + * `MXV` - Mexican Investment Unit - * `MXN` - Mexican Peso + * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) + * `MXP` - Mexican Silver Peso (1861–1992) - * `MDC` - Moldovan Cupon + * `MDC` - Moldovan Cupon - * `MDL` - Moldovan Leu + * `MDL` - Moldovan Leu - * `MCF` - Monegasque Franc + * `MCF` - Monegasque Franc - * `MNT` - Mongolian Tugrik + * `MNT` - Mongolian Tugrik - * `MAD` - Moroccan Dirham + * `MAD` - Moroccan Dirham - * `MAF` - Moroccan Franc + * `MAF` - Moroccan Franc - * `MZE` - Mozambican Escudo + * `MZE` - Mozambican Escudo - * `MZN` - Mozambican Metical + * `MZN` - Mozambican Metical - * `MZM` - Mozambican Metical (1980–2006) + * `MZM` - Mozambican Metical (1980–2006) - * `MMK` - Myanmar Kyat + * `MMK` - Myanmar Kyat - * `NAD` - Namibian Dollar + * `NAD` - Namibian Dollar - * `NPR` - Nepalese Rupee + * `NPR` - Nepalese Rupee - * `ANG` - Netherlands Antillean Guilder + * `ANG` - Netherlands Antillean Guilder - * `TWD` - New Taiwan Dollar + * `TWD` - New Taiwan Dollar - * `NZD` - New Zealand Dollar + * `NZD` - New Zealand Dollar - * `NIO` - Nicaraguan Córdoba + * `NIO` - Nicaraguan Córdoba - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NGN` - Nigerian Naira + * `NGN` - Nigerian Naira - * `KPW` - North Korean Won + * `KPW` - North Korean Won - * `NOK` - Norwegian Krone + * `NOK` - Norwegian Krone - * `OMR` - Omani Rial + * `OMR` - Omani Rial - * `PKR` - Pakistani Rupee + * `PKR` - Pakistani Rupee - * `XPD` - Palladium + * `XPD` - Palladium - * `PAB` - Panamanian Balboa + * `PAB` - Panamanian Balboa - * `PGK` - Papua New Guinean Kina + * `PGK` - Papua New Guinean Kina - * `PYG` - Paraguayan Guarani + * `PYG` - Paraguayan Guarani - * `PEI` - Peruvian Inti + * `PEI` - Peruvian Inti - * `PEN` - Peruvian Sol + * `PEN` - Peruvian Sol - * `PES` - Peruvian Sol (1863–1965) + * `PES` - Peruvian Sol (1863–1965) - * `PHP` - Philippine Peso + * `PHP` - Philippine Peso - * `XPT` - Platinum + * `XPT` - Platinum - * `PLN` - Polish Zloty + * `PLN` - Polish Zloty - * `PLZ` - Polish Zloty (1950–1995) + * `PLZ` - Polish Zloty (1950–1995) - * `PTE` - Portuguese Escudo + * `PTE` - Portuguese Escudo - * `GWE` - Portuguese Guinea Escudo + * `GWE` - Portuguese Guinea Escudo - * `QAR` - Qatari Rial + * `QAR` - Qatari Rial - * `XRE` - RINET Funds + * `XRE` - RINET Funds - * `RHD` - Rhodesian Dollar + * `RHD` - Rhodesian Dollar - * `RON` - Romanian Leu + * `RON` - Romanian Leu - * `ROL` - Romanian Leu (1952–2006) + * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble + * `RUB` - Russian Ruble - * `RUR` - Russian Ruble (1991–1998) + * `RUR` - Russian Ruble (1991–1998) - * `RWF` - Rwandan Franc + * `RWF` - Rwandan Franc - * `SVC` - Salvadoran Colón + * `SVC` - Salvadoran Colón - * `WST` - Samoan Tala + * `WST` - Samoan Tala - * `SAR` - Saudi Riyal + * `SAR` - Saudi Riyal - * `RSD` - Serbian Dinar + * `RSD` - Serbian Dinar - * `CSD` - Serbian Dinar (2002–2006) + * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee + * `SCR` - Seychellois Rupee - * `SLL` - Sierra Leonean Leone + * `SLL` - Sierra Leonean Leone - * `XAG` - Silver + * `XAG` - Silver - * `SGD` - Singapore Dollar + * `SGD` - Singapore Dollar - * `SKK` - Slovak Koruna + * `SKK` - Slovak Koruna - * `SIT` - Slovenian Tolar + * `SIT` - Slovenian Tolar - * `SBD` - Solomon Islands Dollar + * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling + * `SOS` - Somali Shilling - * `ZAR` - South African Rand + * `ZAR` - South African Rand - * `ZAL` - South African Rand (financial) + * `ZAL` - South African Rand (financial) - * `KRH` - South Korean Hwan (1953–1962) + * `KRH` - South Korean Hwan (1953–1962) - * `KRW` - South Korean Won + * `KRW` - South Korean Won - * `KRO` - South Korean Won (1945–1953) + * `KRO` - South Korean Won (1945–1953) - * `SSP` - South Sudanese Pound + * `SSP` - South Sudanese Pound - * `SUR` - Soviet Rouble + * `SUR` - Soviet Rouble - * `ESP` - Spanish Peseta + * `ESP` - Spanish Peseta - * `ESA` - Spanish Peseta (A account) + * `ESA` - Spanish Peseta (A account) - * `ESB` - Spanish Peseta (convertible account) + * `ESB` - Spanish Peseta (convertible account) - * `XDR` - Special Drawing Rights + * `XDR` - Special Drawing Rights - * `LKR` - Sri Lankan Rupee + * `LKR` - Sri Lankan Rupee - * `SHP` - St. Helena Pound + * `SHP` - St. Helena Pound - * `XSU` - Sucre + * `XSU` - Sucre - * `SDD` - Sudanese Dinar (1992–2007) + * `SDD` - Sudanese Dinar (1992–2007) - * `SDG` - Sudanese Pound + * `SDG` - Sudanese Pound - * `SDP` - Sudanese Pound (1957–1998) + * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar + * `SRD` - Surinamese Dollar - * `SRG` - Surinamese Guilder + * `SRG` - Surinamese Guilder - * `SZL` - Swazi Lilangeni + * `SZL` - Swazi Lilangeni - * `SEK` - Swedish Krona + * `SEK` - Swedish Krona - * `CHF` - Swiss Franc + * `CHF` - Swiss Franc - * `SYP` - Syrian Pound + * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra + * `STN` - São Tomé & Príncipe Dobra - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `TVD` - TVD + * `TVD` - TVD - * `TJR` - Tajikistani Ruble + * `TJR` - Tajikistani Ruble - * `TJS` - Tajikistani Somoni + * `TJS` - Tajikistani Somoni - * `TZS` - Tanzanian Shilling + * `TZS` - Tanzanian Shilling - * `XTS` - Testing Currency Code + * `XTS` - Testing Currency Code - * `THB` - Thai Baht + * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is - involved + * `XXX` - The codes assigned for transactions where no currency is + involved - * `TPE` - Timorese Escudo + * `TPE` - Timorese Escudo - * `TOP` - Tongan Paʻanga + * `TOP` - Tongan Paʻanga - * `TTD` - Trinidad & Tobago Dollar + * `TTD` - Trinidad & Tobago Dollar - * `TND` - Tunisian Dinar + * `TND` - Tunisian Dinar - * `TRY` - Turkish Lira + * `TRY` - Turkish Lira - * `TRL` - Turkish Lira (1922–2005) + * `TRL` - Turkish Lira (1922–2005) - * `TMT` - Turkmenistani Manat + * `TMT` - Turkmenistani Manat - * `TMM` - Turkmenistani Manat (1993–2009) + * `TMM` - Turkmenistani Manat (1993–2009) - * `USD` - US Dollar + * `USD` - US Dollar - * `USN` - US Dollar (Next day) + * `USN` - US Dollar (Next day) - * `USS` - US Dollar (Same day) + * `USS` - US Dollar (Same day) - * `UGX` - Ugandan Shilling + * `UGX` - Ugandan Shilling - * `UGS` - Ugandan Shilling (1966–1987) + * `UGS` - Ugandan Shilling (1966–1987) - * `UAH` - Ukrainian Hryvnia + * `UAH` - Ukrainian Hryvnia - * `UAK` - Ukrainian Karbovanets + * `UAK` - Ukrainian Karbovanets - * `AED` - United Arab Emirates Dirham + * `AED` - United Arab Emirates Dirham - * `UYW` - Uruguayan Nominal Wage Index Unit + * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYU` - Uruguayan Peso + * `UYU` - Uruguayan Peso - * `UYP` - Uruguayan Peso (1975–1993) + * `UYP` - Uruguayan Peso (1975–1993) - * `UYI` - Uruguayan Peso (Indexed Units) + * `UYI` - Uruguayan Peso (Indexed Units) - * `UZS` - Uzbekistani Som + * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu + * `VUV` - Vanuatu Vatu - * `VES` - Venezuelan Bolívar + * `VES` - Venezuelan Bolívar - * `VEB` - Venezuelan Bolívar (1871–2008) + * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEF` - Venezuelan Bolívar (2008–2018) + * `VEF` - Venezuelan Bolívar (2008–2018) - * `VND` - Vietnamese Dong + * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) + * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro + * `CHE` - WIR Euro - * `CHW` - WIR Franc + * `CHW` - WIR Franc - * `XOF` - West African CFA Franc + * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar + * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial + * `YER` - Yemeni Rial - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN + * `ZWN` - ZWN - * `ZRN` - Zairean New Zaire (1993–1998) + * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRZ` - Zairean Zaire (1971–1993) + * `ZRZ` - Zairean Zaire (1971–1993) - * `ZMW` - Zambian Kwacha + * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) + * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWR` - Zimbabwean Dollar (2008) + * `ZWR` - Zimbabwean Dollar (2008) - * `ZWL` - Zimbabwean Dollar (2009) - exchange_rate: - type: optional - docs: Exchange rate used if the line item is in a foreign currency. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - is_billable: - type: optional - docs: Whether the expense line is billable to a client or project. - tracking_categories: - docs: >- - The related tracking categories associated with the expense report - (Department, Location, Class, Expense Category) - type: list - employee: - type: optional - docs: >- - Identifier for the employee who submitted or is associated with the - expense report - project: optional - company: - type: optional - docs: The subsidiary that the expense report is created in - contact: optional - quantity: - type: optional - docs: Quantity for the expense line (e.g., miles driven, items purchased). - unit_price: - type: optional - docs: Price per unit for the expense line (if applicable). - non_reimbursable: - type: optional - docs: >- - Whether the expense line is non-reimbursable (e.g., paid via company - card). - tax_amount: - type: optional - docs: Tax amount applicable for the line item. - inclusive_of_tax: - type: optional - docs: Whether the amount is inclusive of tax. - tax_rate: optional - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - remote_fields: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - ExpenseReportLineRequestAccount: - discriminated: false - union: - - type: string - validation: - format: uuid - - Account - source: - openapi: openapi/openapi.yml - inline: true - ExpenseReportLineRequestEmployee: - discriminated: false - docs: >- - Identifier for the employee who submitted or is associated with the - expense report - union: - - type: string - validation: - format: uuid - - Employee - source: - openapi: openapi/openapi.yml - inline: true - ExpenseReportLineRequestProject: - discriminated: false + * `ZWL` - Zimbabwean Dollar (2009) union: - - type: string - validation: - format: uuid - - Project + - TransactionCurrencyEnum + - string source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineRequestCompany: + ExpenseLineRequestAccount: discriminated: false - docs: The subsidiary that the expense report is created in + docs: The expense's payment account. union: - type: string validation: format: uuid - - CompanyInfo + - Account source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineRequestContact: + ExpenseLineRequestContact: discriminated: false + docs: The expense's contact. union: - type: string validation: @@ -22013,52 +17250,52 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineRequestTaxRate: + ExpenseLineRequestProject: discriminated: false union: - type: string validation: format: uuid - - TaxRate + - Project source: openapi: openapi/openapi.yml inline: true - ExpenseReportLineRequest: - docs: >- - # The ExpenseReportLine Object - + ExpenseLineRequest: + docs: |- + # The ExpenseLine Object ### Description - - The `ExpenseReportLine` object represents an individual line item within - an expense report, containing details about - - a specific expense such as amount, description, and associated metadata. - + The `ExpenseLine` object is used to represent an expense's line items. ### Usage Example - - Fetch from the `GET ExpenseReport` endpoint and expand the lines field to - view all line items in the expense report. + Fetch from the `GET Expense` endpoint and view the expense's line items. properties: remote_id: type: optional docs: The third-party API ID of the matching object. - account: optional - description: + item: + type: optional + docs: The line's item. + net_amount: + type: optional + docs: The line's net amount. + tracking_category: + type: optional + availability: deprecated + tracking_categories: + type: optional>> + docs: The expense line item's associated tracking categories. + company: type: optional - docs: Description of the individual expense. + docs: The company the expense belongs to. validation: - maxLength: 1024 - expense_date: - type: optional - docs: The date the individual expense was incurred. - amount: - type: optional - docs: The amount of the expense for the line item. + format: uuid + employee: + type: optional + docs: The employee this overall transaction relates to. currency: - type: optional + type: optional docs: >- - Currency of the expense line (if different from the report currency). + The expense line item's currency. * `XUA` - ADB Unit of Account @@ -22673,47 +17910,26 @@ types: * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) + account: + type: optional + docs: The expense's payment account. + contact: + type: optional + docs: The expense's contact. + project: optional + description: + type: optional + docs: The description of the item that was purchased by the company. exchange_rate: type: optional - docs: Exchange rate used if the line item is in a foreign currency. + docs: The expense line item's exchange rate. validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - is_billable: - type: optional - docs: Whether the expense line is billable to a client or project. - tracking_categories: - docs: >- - The related tracking categories associated with the expense report - (Department, Location, Class, Expense Category) - type: list - employee: - type: optional - docs: >- - Identifier for the employee who submitted or is associated with the - expense report - project: optional - company: - type: optional - docs: The subsidiary that the expense report is created in - contact: optional - quantity: - type: optional - docs: Quantity for the expense line (e.g., miles driven, items purchased). - unit_price: - type: optional - docs: Price per unit for the expense line (if applicable). - non_reimbursable: - type: optional - docs: >- - Whether the expense line is non-reimbursable (e.g., paid via company - card). - tax_amount: - type: optional - docs: Tax amount applicable for the line item. - inclusive_of_tax: - type: optional - docs: Whether the amount is inclusive of tax. - tax_rate: optional + tax_rate: + type: optional + docs: The tax rate that applies to this line item. + validation: + format: uuid integration_params: type: optional> access: write-only @@ -22725,7 +17941,7 @@ types: access: write-only source: openapi: openapi/openapi.yml - ExpenseReportRequestEmployee: + ExpenseReportEmployee: discriminated: false docs: >- Identifier for the employee who submitted or is associated with the @@ -22738,7 +17954,27 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseReportRequestAccountingPeriod: + ExpenseReportStatus: + discriminated: false + docs: >- + Overall status of the expense report. One of DRAFT, SUBMITTED, APPROVED, + REJECTED + + + * `DRAFT` - DRAFT + + * `SUBMITTED` - SUBMITTED + + * `APPROVED` - APPROVED + + * `REJECTED` - REJECTED + union: + - ExpenseReportStatusEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportAccountingPeriod: discriminated: false docs: The accounting period the report was posted in union: @@ -22749,7 +17985,7 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseReportRequestCompany: + ExpenseReportCompany: discriminated: false docs: The subsidiary that the expense report is created in union: @@ -22760,7 +17996,7 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseReportRequest: + ExpenseReport: docs: >- # The ExpenseReport Object @@ -22778,6 +18014,22 @@ types: Fetch from the `GET ExpenseReport` endpoint to view details of expense reports and their line items. properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only report_date: type: optional docs: The date of the expense report. @@ -22787,12 +18039,12 @@ types: validation: maxLength: 1024 employee: - type: optional + type: optional docs: >- Identifier for the employee who submitted or is associated with the expense report status: - type: optional + type: optional docs: >- Overall status of the expense report. One of DRAFT, SUBMITTED, APPROVED, REJECTED @@ -22808,6 +18060,9 @@ types: total_amount: type: optional docs: Total amount of the expense report + lines: + type: optional> + access: read-only currency: type: optional docs: >- @@ -23432,49 +18687,201 @@ types: validation: maxLength: 1024 accounting_period: - type: optional + type: optional docs: The accounting period the report was posted in company: - type: optional + type: optional docs: The subsidiary that the expense report is created in tracking_categories: docs: The related tracking categories associated with the expense report type: list - integration_params: - type: optional> - access: write-only - linked_account_params: + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + field_mappings: type: optional> - access: write-only + access: read-only + remote_data: + type: optional> + access: read-only remote_fields: - type: optional> - access: write-only + type: optional> + access: read-only source: openapi: openapi/openapi.yml - ExpenseReportResponse: - properties: - model: ExpenseReport - warnings: list - errors: list - logs: optional> + ExpenseReportLineAccount: + discriminated: false + union: + - type: string + validation: + format: uuid + - Account source: openapi: openapi/openapi.yml - ExpenseReportStatusEnum: - enum: - - DRAFT - - SUBMITTED - - APPROVED - - REJECTED - docs: |- - * `DRAFT` - DRAFT - * `SUBMITTED` - SUBMITTED - * `APPROVED` - APPROVED - * `REJECTED` - REJECTED + inline: true + ExpenseReportLineEmployee: + discriminated: false + docs: >- + Identifier for the employee who submitted or is associated with the + expense report + union: + - type: string + validation: + format: uuid + - Employee source: openapi: openapi/openapi.yml - ExpenseRequestAccount: + inline: true + ExpenseReportLineProject: + discriminated: false + union: + - type: string + validation: + format: uuid + - Project + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineCompany: + discriminated: false + docs: The subsidiary that the expense report is created in + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineContact: + discriminated: false + union: + - type: string + validation: + format: uuid + - Contact + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineTaxRate: + discriminated: false + union: + - type: string + validation: + format: uuid + - TaxRate + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLine: + docs: >- + # The ExpenseReportLine Object + + ### Description + + The `ExpenseReportLine` object represents an individual line item within + an expense report, containing details about + + a specific expense such as amount, description, and associated metadata. + + + ### Usage Example + + Fetch from the `GET ExpenseReport` endpoint and expand the lines field to + view all line items in the expense report. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + account: optional + description: + type: optional + docs: Description of the individual expense. + validation: + maxLength: 1024 + expense_date: + type: optional + docs: The date the individual expense was incurred. + amount: + type: optional + docs: The amount of the expense for the line item. + currency: optional + exchange_rate: + type: optional + docs: Exchange rate used if the line item is in a foreign currency. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + is_billable: + type: optional + docs: Whether the expense line is billable to a client or project. + tracking_categories: + docs: >- + The related tracking categories associated with the expense report + (Department, Location, Class, Expense Category) + type: list + employee: + type: optional + docs: >- + Identifier for the employee who submitted or is associated with the + expense report + project: optional + company: + type: optional + docs: The subsidiary that the expense report is created in + contact: optional + quantity: + type: optional + docs: Quantity for the expense line (e.g., miles driven, items purchased). + unit_price: + type: optional + docs: Price per unit for the expense line (if applicable). + non_reimbursable: + type: optional + docs: >- + Whether the expense line is non-reimbursable (e.g., paid via company + card). + tax_amount: + type: optional + docs: Tax amount applicable for the line item. + inclusive_of_tax: + type: optional + docs: Whether the amount is inclusive of tax. + tax_rate: optional + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + remote_fields: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + ExpenseReportLineRequestAccount: discriminated: false - docs: The expense's payment account. union: - type: string validation: @@ -23483,9 +18890,42 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseRequestContact: + ExpenseReportLineRequestEmployee: + discriminated: false + docs: >- + Identifier for the employee who submitted or is associated with the + expense report + union: + - type: string + validation: + format: uuid + - Employee + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineRequestProject: + discriminated: false + union: + - type: string + validation: + format: uuid + - Project + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineRequestCompany: + discriminated: false + docs: The subsidiary that the expense report is created in + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineRequestContact: discriminated: false - docs: The expense's contact. union: - type: string validation: @@ -23494,717 +18934,825 @@ types: source: openapi: openapi/openapi.yml inline: true - ExpenseRequestCurrency: + ExpenseReportLineRequestTaxRate: discriminated: false + union: + - type: string + validation: + format: uuid + - TaxRate + source: + openapi: openapi/openapi.yml + inline: true + ExpenseReportLineRequest: docs: >- - The expense's currency. + # The ExpenseReportLine Object + ### Description - * `XUA` - ADB Unit of Account + The `ExpenseReportLine` object represents an individual line item within + an expense report, containing details about - * `AFN` - Afghan Afghani + a specific expense such as amount, description, and associated metadata. - * `AFA` - Afghan Afghani (1927–2002) - * `ALL` - Albanian Lek + ### Usage Example - * `ALK` - Albanian Lek (1946–1965) + Fetch from the `GET ExpenseReport` endpoint and expand the lines field to + view all line items in the expense report. + properties: + remote_id: + type: optional + docs: The third-party API ID of the matching object. + account: optional + description: + type: optional + docs: Description of the individual expense. + validation: + maxLength: 1024 + expense_date: + type: optional + docs: The date the individual expense was incurred. + amount: + type: optional + docs: The amount of the expense for the line item. + currency: + type: optional + docs: >- + Currency of the expense line (if different from the report currency). - * `DZD` - Algerian Dinar - * `ADP` - Andorran Peseta + * `XUA` - ADB Unit of Account - * `AOA` - Angolan Kwanza + * `AFN` - Afghan Afghani - * `AOK` - Angolan Kwanza (1977–1991) + * `AFA` - Afghan Afghani (1927–2002) - * `AON` - Angolan New Kwanza (1990–2000) + * `ALL` - Albanian Lek - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `ALK` - Albanian Lek (1946–1965) - * `ARA` - Argentine Austral + * `DZD` - Algerian Dinar - * `ARS` - Argentine Peso + * `ADP` - Andorran Peseta - * `ARM` - Argentine Peso (1881–1970) + * `AOA` - Angolan Kwanza - * `ARP` - Argentine Peso (1983–1985) + * `AOK` - Angolan Kwanza (1977–1991) - * `ARL` - Argentine Peso Ley (1970–1983) + * `AON` - Angolan New Kwanza (1990–2000) - * `AMD` - Armenian Dram + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `AWG` - Aruban Florin + * `ARA` - Argentine Austral - * `AUD` - Australian Dollar + * `ARS` - Argentine Peso - * `ATS` - Austrian Schilling + * `ARM` - Argentine Peso (1881–1970) - * `AZN` - Azerbaijani Manat + * `ARP` - Argentine Peso (1983–1985) - * `AZM` - Azerbaijani Manat (1993–2006) + * `ARL` - Argentine Peso Ley (1970–1983) - * `BSD` - Bahamian Dollar + * `AMD` - Armenian Dram - * `BHD` - Bahraini Dinar + * `AWG` - Aruban Florin - * `BDT` - Bangladeshi Taka + * `AUD` - Australian Dollar - * `BBD` - Barbadian Dollar + * `ATS` - Austrian Schilling - * `BYN` - Belarusian Ruble + * `AZN` - Azerbaijani Manat - * `BYB` - Belarusian Ruble (1994–1999) + * `AZM` - Azerbaijani Manat (1993–2006) - * `BYR` - Belarusian Ruble (2000–2016) + * `BSD` - Bahamian Dollar - * `BEF` - Belgian Franc + * `BHD` - Bahraini Dinar - * `BEC` - Belgian Franc (convertible) + * `BDT` - Bangladeshi Taka - * `BEL` - Belgian Franc (financial) + * `BBD` - Barbadian Dollar - * `BZD` - Belize Dollar + * `BYN` - Belarusian Ruble - * `BMD` - Bermudan Dollar + * `BYB` - Belarusian Ruble (1994–1999) - * `BTN` - Bhutanese Ngultrum + * `BYR` - Belarusian Ruble (2000–2016) - * `BOB` - Bolivian Boliviano + * `BEF` - Belgian Franc - * `BOL` - Bolivian Boliviano (1863–1963) + * `BEC` - Belgian Franc (convertible) - * `BOV` - Bolivian Mvdol + * `BEL` - Belgian Franc (financial) - * `BOP` - Bolivian Peso + * `BZD` - Belize Dollar - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `BMD` - Bermudan Dollar - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `BTN` - Bhutanese Ngultrum - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `BOB` - Bolivian Boliviano - * `BWP` - Botswanan Pula + * `BOL` - Bolivian Boliviano (1863–1963) - * `BRC` - Brazilian Cruzado (1986–1989) + * `BOV` - Bolivian Mvdol - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `BOP` - Bolivian Peso - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BRN` - Brazilian New Cruzado (1989–1990) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `BWP` - Botswanan Pula - * `BRL` - Brazilian Real + * `BRC` - Brazilian Cruzado (1986–1989) - * `GBP` - British Pound + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BND` - Brunei Dollar + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BGL` - Bulgarian Hard Lev + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BGN` - Bulgarian Lev + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BGO` - Bulgarian Lev (1879–1952) + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BGM` - Bulgarian Socialist Lev + * `BRL` - Brazilian Real - * `BUK` - Burmese Kyat + * `GBP` - British Pound - * `BIF` - Burundian Franc + * `BND` - Brunei Dollar - * `XPF` - CFP Franc + * `BGL` - Bulgarian Hard Lev - * `KHR` - Cambodian Riel + * `BGN` - Bulgarian Lev - * `CAD` - Canadian Dollar + * `BGO` - Bulgarian Lev (1879–1952) - * `CVE` - Cape Verdean Escudo + * `BGM` - Bulgarian Socialist Lev - * `KYD` - Cayman Islands Dollar + * `BUK` - Burmese Kyat - * `XAF` - Central African CFA Franc + * `BIF` - Burundian Franc + + * `XPF` - CFP Franc + + * `KHR` - Cambodian Riel + + * `CAD` - Canadian Dollar + + * `CVE` - Cape Verdean Escudo + + * `KYD` - Cayman Islands Dollar + + * `XAF` - Central African CFA Franc - * `CLE` - Chilean Escudo + * `CLE` - Chilean Escudo - * `CLP` - Chilean Peso + * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) + * `CLF` - Chilean Unit of Account (UF) - * `CNX` - Chinese People’s Bank Dollar + * `CNX` - Chinese People’s Bank Dollar - * `CNY` - Chinese Yuan + * `CNY` - Chinese Yuan - * `CNH` - Chinese Yuan (offshore) + * `CNH` - Chinese Yuan (offshore) - * `COP` - Colombian Peso + * `COP` - Colombian Peso - * `COU` - Colombian Real Value Unit + * `COU` - Colombian Real Value Unit - * `KMF` - Comorian Franc + * `KMF` - Comorian Franc - * `CDF` - Congolese Franc + * `CDF` - Congolese Franc - * `CRC` - Costa Rican Colón + * `CRC` - Costa Rican Colón - * `HRD` - Croatian Dinar + * `HRD` - Croatian Dinar - * `HRK` - Croatian Kuna + * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso + * `CUC` - Cuban Convertible Peso - * `CUP` - Cuban Peso + * `CUP` - Cuban Peso - * `CYP` - Cypriot Pound + * `CYP` - Cypriot Pound - * `CZK` - Czech Koruna + * `CZK` - Czech Koruna - * `CSK` - Czechoslovak Hard Koruna + * `CSK` - Czechoslovak Hard Koruna - * `DKK` - Danish Krone + * `DKK` - Danish Krone - * `DJF` - Djiboutian Franc + * `DJF` - Djiboutian Franc - * `DOP` - Dominican Peso + * `DOP` - Dominican Peso - * `NLG` - Dutch Guilder + * `NLG` - Dutch Guilder - * `XCD` - East Caribbean Dollar + * `XCD` - East Caribbean Dollar - * `DDM` - East German Mark + * `DDM` - East German Mark - * `ECS` - Ecuadorian Sucre + * `ECS` - Ecuadorian Sucre - * `ECV` - Ecuadorian Unit of Constant Value + * `ECV` - Ecuadorian Unit of Constant Value - * `EGP` - Egyptian Pound + * `EGP` - Egyptian Pound - * `GQE` - Equatorial Guinean Ekwele + * `GQE` - Equatorial Guinean Ekwele - * `ERN` - Eritrean Nakfa + * `ERN` - Eritrean Nakfa - * `EEK` - Estonian Kroon + * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr + * `ETB` - Ethiopian Birr - * `EUR` - Euro + * `EUR` - Euro - * `XBA` - European Composite Unit + * `XBA` - European Composite Unit - * `XEU` - European Currency Unit + * `XEU` - European Currency Unit - * `XBB` - European Monetary Unit + * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) + * `XBC` - European Unit of Account (XBC) - * `XBD` - European Unit of Account (XBD) + * `XBD` - European Unit of Account (XBD) - * `FKP` - Falkland Islands Pound + * `FKP` - Falkland Islands Pound - * `FJD` - Fijian Dollar + * `FJD` - Fijian Dollar - * `FIM` - Finnish Markka + * `FIM` - Finnish Markka - * `FRF` - French Franc + * `FRF` - French Franc - * `XFO` - French Gold Franc + * `XFO` - French Gold Franc - * `XFU` - French UIC-Franc + * `XFU` - French UIC-Franc - * `GMD` - Gambian Dalasi + * `GMD` - Gambian Dalasi - * `GEK` - Georgian Kupon Larit + * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari + * `GEL` - Georgian Lari - * `DEM` - German Mark + * `DEM` - German Mark - * `GHS` - Ghanaian Cedi + * `GHS` - Ghanaian Cedi - * `GHC` - Ghanaian Cedi (1979–2007) + * `GHC` - Ghanaian Cedi (1979–2007) - * `GIP` - Gibraltar Pound + * `GIP` - Gibraltar Pound - * `XAU` - Gold + * `XAU` - Gold - * `GRD` - Greek Drachma + * `GRD` - Greek Drachma - * `GTQ` - Guatemalan Quetzal + * `GTQ` - Guatemalan Quetzal - * `GWP` - Guinea-Bissau Peso + * `GWP` - Guinea-Bissau Peso - * `GNF` - Guinean Franc + * `GNF` - Guinean Franc - * `GNS` - Guinean Syli + * `GNS` - Guinean Syli - * `GYD` - Guyanaese Dollar + * `GYD` - Guyanaese Dollar - * `HTG` - Haitian Gourde + * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira + * `HNL` - Honduran Lempira - * `HKD` - Hong Kong Dollar + * `HKD` - Hong Kong Dollar - * `HUF` - Hungarian Forint + * `HUF` - Hungarian Forint - * `IMP` - IMP + * `IMP` - IMP - * `ISK` - Icelandic Króna + * `ISK` - Icelandic Króna - * `ISJ` - Icelandic Króna (1918–1981) + * `ISJ` - Icelandic Króna (1918–1981) - * `INR` - Indian Rupee + * `INR` - Indian Rupee - * `IDR` - Indonesian Rupiah + * `IDR` - Indonesian Rupiah - * `IRR` - Iranian Rial + * `IRR` - Iranian Rial - * `IQD` - Iraqi Dinar + * `IQD` - Iraqi Dinar - * `IEP` - Irish Pound + * `IEP` - Irish Pound - * `ILS` - Israeli New Shekel + * `ILS` - Israeli New Shekel - * `ILP` - Israeli Pound + * `ILP` - Israeli Pound - * `ILR` - Israeli Shekel (1980–1985) + * `ILR` - Israeli Shekel (1980–1985) - * `ITL` - Italian Lira + * `ITL` - Italian Lira - * `JMD` - Jamaican Dollar + * `JMD` - Jamaican Dollar - * `JPY` - Japanese Yen + * `JPY` - Japanese Yen - * `JOD` - Jordanian Dinar + * `JOD` - Jordanian Dinar - * `KZT` - Kazakhstani Tenge + * `KZT` - Kazakhstani Tenge - * `KES` - Kenyan Shilling + * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar + * `KWD` - Kuwaiti Dinar - * `KGS` - Kyrgystani Som + * `KGS` - Kyrgystani Som - * `LAK` - Laotian Kip + * `LAK` - Laotian Kip - * `LVL` - Latvian Lats + * `LVL` - Latvian Lats - * `LVR` - Latvian Ruble + * `LVR` - Latvian Ruble - * `LBP` - Lebanese Pound + * `LBP` - Lebanese Pound - * `LSL` - Lesotho Loti + * `LSL` - Lesotho Loti - * `LRD` - Liberian Dollar + * `LRD` - Liberian Dollar - * `LYD` - Libyan Dinar + * `LYD` - Libyan Dinar - * `LTL` - Lithuanian Litas + * `LTL` - Lithuanian Litas - * `LTT` - Lithuanian Talonas + * `LTT` - Lithuanian Talonas - * `LUL` - Luxembourg Financial Franc + * `LUL` - Luxembourg Financial Franc - * `LUC` - Luxembourgian Convertible Franc + * `LUC` - Luxembourgian Convertible Franc - * `LUF` - Luxembourgian Franc + * `LUF` - Luxembourgian Franc - * `MOP` - Macanese Pataca + * `MOP` - Macanese Pataca - * `MKD` - Macedonian Denar + * `MKD` - Macedonian Denar - * `MKN` - Macedonian Denar (1992–1993) + * `MKN` - Macedonian Denar (1992–1993) - * `MGA` - Malagasy Ariary + * `MGA` - Malagasy Ariary - * `MGF` - Malagasy Franc + * `MGF` - Malagasy Franc - * `MWK` - Malawian Kwacha + * `MWK` - Malawian Kwacha - * `MYR` - Malaysian Ringgit + * `MYR` - Malaysian Ringgit - * `MVR` - Maldivian Rufiyaa + * `MVR` - Maldivian Rufiyaa - * `MVP` - Maldivian Rupee (1947–1981) + * `MVP` - Maldivian Rupee (1947–1981) - * `MLF` - Malian Franc + * `MLF` - Malian Franc - * `MTL` - Maltese Lira + * `MTL` - Maltese Lira - * `MTP` - Maltese Pound + * `MTP` - Maltese Pound - * `MRU` - Mauritanian Ouguiya + * `MRU` - Mauritanian Ouguiya - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MUR` - Mauritian Rupee + * `MUR` - Mauritian Rupee - * `MXV` - Mexican Investment Unit + * `MXV` - Mexican Investment Unit - * `MXN` - Mexican Peso + * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) + * `MXP` - Mexican Silver Peso (1861–1992) - * `MDC` - Moldovan Cupon + * `MDC` - Moldovan Cupon - * `MDL` - Moldovan Leu + * `MDL` - Moldovan Leu - * `MCF` - Monegasque Franc + * `MCF` - Monegasque Franc - * `MNT` - Mongolian Tugrik + * `MNT` - Mongolian Tugrik - * `MAD` - Moroccan Dirham + * `MAD` - Moroccan Dirham - * `MAF` - Moroccan Franc + * `MAF` - Moroccan Franc - * `MZE` - Mozambican Escudo + * `MZE` - Mozambican Escudo - * `MZN` - Mozambican Metical + * `MZN` - Mozambican Metical - * `MZM` - Mozambican Metical (1980–2006) + * `MZM` - Mozambican Metical (1980–2006) - * `MMK` - Myanmar Kyat + * `MMK` - Myanmar Kyat - * `NAD` - Namibian Dollar + * `NAD` - Namibian Dollar - * `NPR` - Nepalese Rupee + * `NPR` - Nepalese Rupee - * `ANG` - Netherlands Antillean Guilder + * `ANG` - Netherlands Antillean Guilder - * `TWD` - New Taiwan Dollar + * `TWD` - New Taiwan Dollar - * `NZD` - New Zealand Dollar + * `NZD` - New Zealand Dollar - * `NIO` - Nicaraguan Córdoba + * `NIO` - Nicaraguan Córdoba - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NGN` - Nigerian Naira + * `NGN` - Nigerian Naira - * `KPW` - North Korean Won + * `KPW` - North Korean Won - * `NOK` - Norwegian Krone + * `NOK` - Norwegian Krone - * `OMR` - Omani Rial + * `OMR` - Omani Rial - * `PKR` - Pakistani Rupee + * `PKR` - Pakistani Rupee - * `XPD` - Palladium + * `XPD` - Palladium - * `PAB` - Panamanian Balboa + * `PAB` - Panamanian Balboa - * `PGK` - Papua New Guinean Kina + * `PGK` - Papua New Guinean Kina - * `PYG` - Paraguayan Guarani + * `PYG` - Paraguayan Guarani - * `PEI` - Peruvian Inti + * `PEI` - Peruvian Inti - * `PEN` - Peruvian Sol + * `PEN` - Peruvian Sol - * `PES` - Peruvian Sol (1863–1965) + * `PES` - Peruvian Sol (1863–1965) - * `PHP` - Philippine Peso + * `PHP` - Philippine Peso - * `XPT` - Platinum + * `XPT` - Platinum - * `PLN` - Polish Zloty + * `PLN` - Polish Zloty - * `PLZ` - Polish Zloty (1950–1995) + * `PLZ` - Polish Zloty (1950–1995) - * `PTE` - Portuguese Escudo + * `PTE` - Portuguese Escudo - * `GWE` - Portuguese Guinea Escudo + * `GWE` - Portuguese Guinea Escudo - * `QAR` - Qatari Rial + * `QAR` - Qatari Rial - * `XRE` - RINET Funds + * `XRE` - RINET Funds - * `RHD` - Rhodesian Dollar + * `RHD` - Rhodesian Dollar - * `RON` - Romanian Leu + * `RON` - Romanian Leu - * `ROL` - Romanian Leu (1952–2006) + * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble + * `RUB` - Russian Ruble - * `RUR` - Russian Ruble (1991–1998) + * `RUR` - Russian Ruble (1991–1998) - * `RWF` - Rwandan Franc + * `RWF` - Rwandan Franc - * `SVC` - Salvadoran Colón + * `SVC` - Salvadoran Colón - * `WST` - Samoan Tala + * `WST` - Samoan Tala - * `SAR` - Saudi Riyal + * `SAR` - Saudi Riyal - * `RSD` - Serbian Dinar + * `RSD` - Serbian Dinar - * `CSD` - Serbian Dinar (2002–2006) + * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee + * `SCR` - Seychellois Rupee - * `SLL` - Sierra Leonean Leone + * `SLL` - Sierra Leonean Leone - * `XAG` - Silver + * `XAG` - Silver - * `SGD` - Singapore Dollar + * `SGD` - Singapore Dollar - * `SKK` - Slovak Koruna + * `SKK` - Slovak Koruna - * `SIT` - Slovenian Tolar + * `SIT` - Slovenian Tolar - * `SBD` - Solomon Islands Dollar + * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling + * `SOS` - Somali Shilling - * `ZAR` - South African Rand + * `ZAR` - South African Rand - * `ZAL` - South African Rand (financial) + * `ZAL` - South African Rand (financial) - * `KRH` - South Korean Hwan (1953–1962) + * `KRH` - South Korean Hwan (1953–1962) - * `KRW` - South Korean Won + * `KRW` - South Korean Won - * `KRO` - South Korean Won (1945–1953) + * `KRO` - South Korean Won (1945–1953) - * `SSP` - South Sudanese Pound + * `SSP` - South Sudanese Pound - * `SUR` - Soviet Rouble + * `SUR` - Soviet Rouble - * `ESP` - Spanish Peseta + * `ESP` - Spanish Peseta - * `ESA` - Spanish Peseta (A account) + * `ESA` - Spanish Peseta (A account) - * `ESB` - Spanish Peseta (convertible account) + * `ESB` - Spanish Peseta (convertible account) - * `XDR` - Special Drawing Rights + * `XDR` - Special Drawing Rights - * `LKR` - Sri Lankan Rupee + * `LKR` - Sri Lankan Rupee - * `SHP` - St. Helena Pound + * `SHP` - St. Helena Pound - * `XSU` - Sucre + * `XSU` - Sucre - * `SDD` - Sudanese Dinar (1992–2007) + * `SDD` - Sudanese Dinar (1992–2007) - * `SDG` - Sudanese Pound + * `SDG` - Sudanese Pound - * `SDP` - Sudanese Pound (1957–1998) + * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar + * `SRD` - Surinamese Dollar - * `SRG` - Surinamese Guilder + * `SRG` - Surinamese Guilder - * `SZL` - Swazi Lilangeni + * `SZL` - Swazi Lilangeni - * `SEK` - Swedish Krona + * `SEK` - Swedish Krona - * `CHF` - Swiss Franc + * `CHF` - Swiss Franc - * `SYP` - Syrian Pound + * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra + * `STN` - São Tomé & Príncipe Dobra - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `TVD` - TVD + * `TVD` - TVD - * `TJR` - Tajikistani Ruble + * `TJR` - Tajikistani Ruble - * `TJS` - Tajikistani Somoni + * `TJS` - Tajikistani Somoni - * `TZS` - Tanzanian Shilling + * `TZS` - Tanzanian Shilling - * `XTS` - Testing Currency Code + * `XTS` - Testing Currency Code - * `THB` - Thai Baht + * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is - involved + * `XXX` - The codes assigned for transactions where no currency is + involved - * `TPE` - Timorese Escudo + * `TPE` - Timorese Escudo - * `TOP` - Tongan Paʻanga + * `TOP` - Tongan Paʻanga - * `TTD` - Trinidad & Tobago Dollar + * `TTD` - Trinidad & Tobago Dollar - * `TND` - Tunisian Dinar + * `TND` - Tunisian Dinar - * `TRY` - Turkish Lira + * `TRY` - Turkish Lira - * `TRL` - Turkish Lira (1922–2005) + * `TRL` - Turkish Lira (1922–2005) - * `TMT` - Turkmenistani Manat + * `TMT` - Turkmenistani Manat - * `TMM` - Turkmenistani Manat (1993–2009) + * `TMM` - Turkmenistani Manat (1993–2009) - * `USD` - US Dollar + * `USD` - US Dollar - * `USN` - US Dollar (Next day) + * `USN` - US Dollar (Next day) - * `USS` - US Dollar (Same day) + * `USS` - US Dollar (Same day) - * `UGX` - Ugandan Shilling + * `UGX` - Ugandan Shilling - * `UGS` - Ugandan Shilling (1966–1987) + * `UGS` - Ugandan Shilling (1966–1987) - * `UAH` - Ukrainian Hryvnia + * `UAH` - Ukrainian Hryvnia - * `UAK` - Ukrainian Karbovanets + * `UAK` - Ukrainian Karbovanets - * `AED` - United Arab Emirates Dirham + * `AED` - United Arab Emirates Dirham - * `UYW` - Uruguayan Nominal Wage Index Unit + * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYU` - Uruguayan Peso + * `UYU` - Uruguayan Peso - * `UYP` - Uruguayan Peso (1975–1993) + * `UYP` - Uruguayan Peso (1975–1993) - * `UYI` - Uruguayan Peso (Indexed Units) + * `UYI` - Uruguayan Peso (Indexed Units) - * `UZS` - Uzbekistani Som + * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu + * `VUV` - Vanuatu Vatu - * `VES` - Venezuelan Bolívar + * `VES` - Venezuelan Bolívar - * `VEB` - Venezuelan Bolívar (1871–2008) + * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEF` - Venezuelan Bolívar (2008–2018) + * `VEF` - Venezuelan Bolívar (2008–2018) - * `VND` - Vietnamese Dong + * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) + * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro + * `CHE` - WIR Euro - * `CHW` - WIR Franc + * `CHW` - WIR Franc - * `XOF` - West African CFA Franc + * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar + * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial + * `YER` - Yemeni Rial - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN + * `ZWN` - ZWN - * `ZRN` - Zairean New Zaire (1993–1998) + * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRZ` - Zairean Zaire (1971–1993) + * `ZRZ` - Zairean Zaire (1971–1993) - * `ZMW` - Zambian Kwacha + * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) + * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWR` - Zimbabwean Dollar (2008) + * `ZWR` - Zimbabwean Dollar (2008) - * `ZWL` - Zimbabwean Dollar (2009) - union: - - TransactionCurrencyEnum - - string + * `ZWL` - Zimbabwean Dollar (2009) + exchange_rate: + type: optional + docs: Exchange rate used if the line item is in a foreign currency. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + is_billable: + type: optional + docs: Whether the expense line is billable to a client or project. + tracking_categories: + docs: >- + The related tracking categories associated with the expense report + (Department, Location, Class, Expense Category) + type: list + employee: + type: optional + docs: >- + Identifier for the employee who submitted or is associated with the + expense report + project: optional + company: + type: optional + docs: The subsidiary that the expense report is created in + contact: optional + quantity: + type: optional + docs: Quantity for the expense line (e.g., miles driven, items purchased). + unit_price: + type: optional + docs: Price per unit for the expense line (if applicable). + non_reimbursable: + type: optional + docs: >- + Whether the expense line is non-reimbursable (e.g., paid via company + card). + tax_amount: + type: optional + docs: Tax amount applicable for the line item. + inclusive_of_tax: + type: optional + docs: Whether the amount is inclusive of tax. + tax_rate: optional + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + remote_fields: + type: optional> + access: write-only source: openapi: openapi/openapi.yml - inline: true - ExpenseRequestCompany: + ExpenseReportRequestEmployee: discriminated: false - docs: The company the expense belongs to. + docs: >- + Identifier for the employee who submitted or is associated with the + expense report union: - type: string validation: format: uuid - - CompanyInfo + - Employee source: openapi: openapi/openapi.yml inline: true - ExpenseRequestEmployee: + ExpenseReportRequestStatus: discriminated: false - docs: The employee this overall transaction relates to. + docs: >- + Overall status of the expense report. One of DRAFT, SUBMITTED, APPROVED, + REJECTED + + + * `DRAFT` - DRAFT + + * `SUBMITTED` - SUBMITTED + + * `APPROVED` - APPROVED + + * `REJECTED` - REJECTED union: - - type: string - validation: - format: uuid - - Employee + - ExpenseReportStatusEnum + - string source: openapi: openapi/openapi.yml inline: true - ExpenseRequestTrackingCategoriesItem: + ExpenseReportRequestAccountingPeriod: discriminated: false + docs: The accounting period the report was posted in union: - type: string validation: format: uuid - - TrackingCategory + - AccountingPeriod source: openapi: openapi/openapi.yml inline: true - ExpenseRequestAccountingPeriod: + ExpenseReportRequestCompany: discriminated: false - docs: The accounting period that the Expense was generated in. + docs: The subsidiary that the expense report is created in union: - type: string validation: format: uuid - - AccountingPeriod + - CompanyInfo source: openapi: openapi/openapi.yml inline: true - ExpenseRequest: + ExpenseReportRequest: docs: >- - # The Expense Object + # The ExpenseReport Object ### Description - The `Expense` object is used to represent a direct purchase by a business, - typically made with a check, credit card, or cash. Each `Expense` object - is dedicated to a grouping of expenses, with each expense recorded in the - lines object. - + The `ExpenseReport` object represents a collection of expenses submitted + for review and reimbursement. - The `Expense` object is used also used to represent refunds to direct - purchases. Refunds can be distinguished from purchases by the amount sign - of the records. Expense objects with a negative amount are purchases and - `Expense` objects with a positive amount are refunds to those purchases. + It includes details about the submitter, status, amounts, and associated + metadata. ### Usage Example - Fetch from the `GET Expense` endpoint and view a company's expense. + Fetch from the `GET ExpenseReport` endpoint to view details of expense + reports and their line items. properties: - transaction_date: + report_date: type: optional - docs: When the transaction occurred. - account: - type: optional - docs: The expense's payment account. - contact: - type: optional - docs: The expense's contact. + docs: The date of the expense report. + report_identifier: + type: optional + docs: Human-readable expense report identifier. + validation: + maxLength: 1024 + employee: + type: optional + docs: >- + Identifier for the employee who submitted or is associated with the + expense report + status: + type: optional + docs: >- + Overall status of the expense report. One of DRAFT, SUBMITTED, + APPROVED, REJECTED + + + * `DRAFT` - DRAFT + + * `SUBMITTED` - SUBMITTED + + * `APPROVED` - APPROVED + + * `REJECTED` - REJECTED total_amount: type: optional - docs: The expense's total amount. - sub_total: - type: optional - docs: The expense's total amount before tax. - total_tax_amount: - type: optional - docs: The expense's total tax amount. + docs: Total amount of the expense report currency: - type: optional + type: optional docs: >- - The expense's currency. + Currency code for the expense report * `XUA` - ADB Unit of Account @@ -24665,574 +20213,220 @@ types: * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling - - * `ZAR` - South African Rand - - * `ZAL` - South African Rand (financial) - - * `KRH` - South Korean Hwan (1953–1962) - - * `KRW` - South Korean Won - - * `KRO` - South Korean Won (1945–1953) - - * `SSP` - South Sudanese Pound - - * `SUR` - Soviet Rouble - - * `ESP` - Spanish Peseta - - * `ESA` - Spanish Peseta (A account) - - * `ESB` - Spanish Peseta (convertible account) - - * `XDR` - Special Drawing Rights - - * `LKR` - Sri Lankan Rupee - - * `SHP` - St. Helena Pound - - * `XSU` - Sucre - - * `SDD` - Sudanese Dinar (1992–2007) - - * `SDG` - Sudanese Pound - - * `SDP` - Sudanese Pound (1957–1998) - - * `SRD` - Surinamese Dollar - - * `SRG` - Surinamese Guilder - - * `SZL` - Swazi Lilangeni - - * `SEK` - Swedish Krona - - * `CHF` - Swiss Franc - - * `SYP` - Syrian Pound - - * `STN` - São Tomé & Príncipe Dobra - - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - - * `TVD` - TVD - - * `TJR` - Tajikistani Ruble - - * `TJS` - Tajikistani Somoni - - * `TZS` - Tanzanian Shilling - - * `XTS` - Testing Currency Code - - * `THB` - Thai Baht - - * `XXX` - The codes assigned for transactions where no currency is - involved - - * `TPE` - Timorese Escudo - - * `TOP` - Tongan Paʻanga - - * `TTD` - Trinidad & Tobago Dollar - - * `TND` - Tunisian Dinar - - * `TRY` - Turkish Lira - - * `TRL` - Turkish Lira (1922–2005) - - * `TMT` - Turkmenistani Manat - - * `TMM` - Turkmenistani Manat (1993–2009) - - * `USD` - US Dollar - - * `USN` - US Dollar (Next day) - - * `USS` - US Dollar (Same day) - - * `UGX` - Ugandan Shilling - - * `UGS` - Ugandan Shilling (1966–1987) - - * `UAH` - Ukrainian Hryvnia - - * `UAK` - Ukrainian Karbovanets - - * `AED` - United Arab Emirates Dirham - - * `UYW` - Uruguayan Nominal Wage Index Unit - - * `UYU` - Uruguayan Peso - - * `UYP` - Uruguayan Peso (1975–1993) - - * `UYI` - Uruguayan Peso (Indexed Units) - - * `UZS` - Uzbekistani Som - - * `VUV` - Vanuatu Vatu - - * `VES` - Venezuelan Bolívar - - * `VEB` - Venezuelan Bolívar (1871–2008) - - * `VEF` - Venezuelan Bolívar (2008–2018) - - * `VND` - Vietnamese Dong - - * `VNN` - Vietnamese Dong (1978–1985) - - * `CHE` - WIR Euro - - * `CHW` - WIR Franc - - * `XOF` - West African CFA Franc - - * `YDD` - Yemeni Dinar - - * `YER` - Yemeni Rial - - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - - * `YUM` - Yugoslavian New Dinar (1994–2002) - - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - - * `ZWN` - ZWN - - * `ZRN` - Zairean New Zaire (1993–1998) - - * `ZRZ` - Zairean Zaire (1971–1993) - - * `ZMW` - Zambian Kwacha - - * `ZMK` - Zambian Kwacha (1968–2012) - - * `ZWD` - Zimbabwean Dollar (1980–2008) - - * `ZWR` - Zimbabwean Dollar (2008) - - * `ZWL` - Zimbabwean Dollar (2009) - exchange_rate: - type: optional - docs: The expense's exchange rate. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - inclusive_of_tax: - type: optional - docs: >- - If the transaction is inclusive or exclusive of tax. `True` if - inclusive, `False` if exclusive. - company: - type: optional - docs: The company the expense belongs to. - employee: - type: optional - docs: The employee this overall transaction relates to. - memo: - type: optional - docs: The expense's private note. - lines: optional> - tracking_categories: optional>> - accounting_period: - type: optional - docs: The accounting period that the Expense was generated in. - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - remote_fields: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - ExpenseResponse: - properties: - model: Expense - warnings: list - errors: list - logs: optional> - source: - openapi: openapi/openapi.yml - ExternalTargetFieldApi: - properties: - name: - type: optional - access: read-only - description: - type: optional - access: read-only - is_mapped: - type: optional - access: read-only - source: - openapi: openapi/openapi.yml - ExternalTargetFieldApiResponse: - properties: - Account: optional> - AccountingAttachment: optional> - BalanceSheet: optional> - CashFlowStatement: optional> - CompanyInfo: optional> - Contact: optional> - IncomeStatement: optional> - CreditNote: optional> - Item: optional> - PurchaseOrder: optional> - ExpenseReport: optional> - TrackingCategory: optional> - JournalEntry: optional> - TaxRate: optional> - Invoice: optional> - Payment: optional> - Expense: optional> - VendorCredit: optional> - Transaction: optional> - AccountingPeriod: optional> - GeneralLedgerTransaction: optional> - BankFeedAccount: optional> - Employee: optional> - PaymentMethod: optional> - Project: optional> - PaymentTerm: optional> - source: - openapi: openapi/openapi.yml - FeedStatusEnum: - enum: - - ACTIVE - - INACTIVE - docs: |- - * `ACTIVE` - ACTIVE - * `INACTIVE` - INACTIVE - source: - openapi: openapi/openapi.yml - FieldFormatEnum: - enum: - - string - - number - - date - - datetime - - bool - - list - docs: |- - * `string` - string - * `number` - number - * `date` - date - * `datetime` - datetime - * `bool` - bool - * `list` - list - source: - openapi: openapi/openapi.yml - FieldMappingApiInstanceTargetField: - properties: - name: string - description: string - is_organization_wide: boolean - source: - openapi: openapi/openapi.yml - inline: true - FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo: - properties: - method: optional - url_path: optional - field_traversal_path: optional> - source: - openapi: openapi/openapi.yml - inline: true - FieldMappingApiInstanceRemoteField: - properties: - remote_key_name: optional - schema: optional> - remote_endpoint_info: FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo - source: - openapi: openapi/openapi.yml - inline: true - FieldMappingApiInstance: - properties: - id: - type: optional - validation: - format: uuid - access: read-only - is_integration_wide: - type: optional - access: read-only - target_field: - type: optional - access: read-only - remote_field: - type: optional - access: read-only - source: - openapi: openapi/openapi.yml - FieldMappingApiInstanceResponse: - properties: - Account: optional> - AccountingAttachment: optional> - BalanceSheet: optional> - CashFlowStatement: optional> - CompanyInfo: optional> - Contact: optional> - IncomeStatement: optional> - CreditNote: optional> - Item: optional> - PurchaseOrder: optional> - ExpenseReport: optional> - TrackingCategory: optional> - JournalEntry: optional> - TaxRate: optional> - Invoice: optional> - Payment: optional> - Expense: optional> - VendorCredit: optional> - Transaction: optional> - AccountingPeriod: optional> - GeneralLedgerTransaction: optional> - BankFeedAccount: optional> - Employee: optional> - PaymentMethod: optional> - Project: optional> - PaymentTerm: optional> - source: - openapi: openapi/openapi.yml - FieldMappingInstanceResponse: - properties: - model: FieldMappingApiInstance - warnings: list - errors: list - logs: optional> - source: - openapi: openapi/openapi.yml - FieldPermissionDeserializer: - properties: - enabled_fields: optional> - disabled_fields: optional> - source: - openapi: openapi/openapi.yml - FieldPermissionDeserializerRequest: - properties: - enabled_fields: optional> - disabled_fields: optional> - source: - openapi: openapi/openapi.yml - FieldTypeEnum: - enum: - - string - - number - - date - - datetime - - bool - - list - docs: |- - * `string` - string - * `number` - number - * `date` - date - * `datetime` - datetime - * `bool` - bool - * `list` - list - source: - openapi: openapi/openapi.yml - GeneralLedgerTransactionUnderlyingTransactionType: - discriminated: false - docs: |- - The type of the underlying transaction. + * `SOS` - Somali Shilling - * `INVOICE` - INVOICE - * `EXPENSE` - EXPENSE - * `TRANSACTION` - TRANSACTION - * `JOURNAL_ENTRY` - JOURNAL_ENTRY - * `PAYMENT` - PAYMENT - * `VENDOR_CREDIT` - VENDOR_CREDIT - * `CREDIT_NOTE` - CREDIT_NOTE - union: - - UnderlyingTransactionTypeEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - GeneralLedgerTransactionAccountingPeriod: - discriminated: false - docs: The accounting period that the GeneralLedgerTransaction was generated in. - union: - - type: string - validation: - format: uuid - - AccountingPeriod - source: - openapi: openapi/openapi.yml - inline: true - GeneralLedgerTransactionCompany: - discriminated: false - docs: The company the GeneralLedgerTransaction belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true - GeneralLedgerTransactionTrackingCategoriesItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - TrackingCategory - source: - openapi: openapi/openapi.yml - inline: true - GeneralLedgerTransactionGeneralLedgerTransactionLinesItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - GeneralLedgerTransactionLine - source: - openapi: openapi/openapi.yml - inline: true - GeneralLedgerTransaction: - docs: >- - # The GeneralLedgerTransaction Object + * `ZAR` - South African Rand - ### Description + * `ZAL` - South African Rand (financial) - A General Ledger Entry is a record of a financial transaction that is - posted to the general ledger, the central repository of a company’s - financial data. + * `KRH` - South Korean Hwan (1953–1962) + * `KRW` - South Korean Won - The `GeneralLedgerTransaction` object is a singular endpoint to pull all - transactions posted to a company’s general ledger. The transaction that - generated the `GeneralLedgerTransaction` can be found by referencing the - `underlying_transaction_type` and `underlying_transaction_remote_id` - fields. + * `KRO` - South Korean Won (1945–1953) + * `SSP` - South Sudanese Pound - The lines of a `GeneralLedgerTransaction` object will always have equal - amounts of debits and credits. + * `SUR` - Soviet Rouble + * `ESP` - Spanish Peseta - ### Usage Example + * `ESA` - Spanish Peseta (A account) - Fetch from the `GET GeneralLedgerTransaction` endpoint and view a general - ledger transaction. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - underlying_transaction_remote_id: + * `ESB` - Spanish Peseta (convertible account) + + * `XDR` - Special Drawing Rights + + * `LKR` - Sri Lankan Rupee + + * `SHP` - St. Helena Pound + + * `XSU` - Sucre + + * `SDD` - Sudanese Dinar (1992–2007) + + * `SDG` - Sudanese Pound + + * `SDP` - Sudanese Pound (1957–1998) + + * `SRD` - Surinamese Dollar + + * `SRG` - Surinamese Guilder + + * `SZL` - Swazi Lilangeni + + * `SEK` - Swedish Krona + + * `CHF` - Swiss Franc + + * `SYP` - Syrian Pound + + * `STN` - São Tomé & Príncipe Dobra + + * `STD` - São Tomé & Príncipe Dobra (1977–2017) + + * `TVD` - TVD + + * `TJR` - Tajikistani Ruble + + * `TJS` - Tajikistani Somoni + + * `TZS` - Tanzanian Shilling + + * `XTS` - Testing Currency Code + + * `THB` - Thai Baht + + * `XXX` - The codes assigned for transactions where no currency is + involved + + * `TPE` - Timorese Escudo + + * `TOP` - Tongan Paʻanga + + * `TTD` - Trinidad & Tobago Dollar + + * `TND` - Tunisian Dinar + + * `TRY` - Turkish Lira + + * `TRL` - Turkish Lira (1922–2005) + + * `TMT` - Turkmenistani Manat + + * `TMM` - Turkmenistani Manat (1993–2009) + + * `USD` - US Dollar + + * `USN` - US Dollar (Next day) + + * `USS` - US Dollar (Same day) + + * `UGX` - Ugandan Shilling + + * `UGS` - Ugandan Shilling (1966–1987) + + * `UAH` - Ukrainian Hryvnia + + * `UAK` - Ukrainian Karbovanets + + * `AED` - United Arab Emirates Dirham + + * `UYW` - Uruguayan Nominal Wage Index Unit + + * `UYU` - Uruguayan Peso + + * `UYP` - Uruguayan Peso (1975–1993) + + * `UYI` - Uruguayan Peso (Indexed Units) + + * `UZS` - Uzbekistani Som + + * `VUV` - Vanuatu Vatu + + * `VES` - Venezuelan Bolívar + + * `VEB` - Venezuelan Bolívar (1871–2008) + + * `VEF` - Venezuelan Bolívar (2008–2018) + + * `VND` - Vietnamese Dong + + * `VNN` - Vietnamese Dong (1978–1985) + + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) + description: type: optional - docs: The third party remote ID of the underlying transaction. + docs: A brief description or purpose for the expense report validation: - maxLength: 50 - underlying_transaction_type: - type: optional - docs: |- - The type of the underlying transaction. - - * `INVOICE` - INVOICE - * `EXPENSE` - EXPENSE - * `TRANSACTION` - TRANSACTION - * `JOURNAL_ENTRY` - JOURNAL_ENTRY - * `PAYMENT` - PAYMENT - * `VENDOR_CREDIT` - VENDOR_CREDIT - * `CREDIT_NOTE` - CREDIT_NOTE + maxLength: 1024 accounting_period: - type: optional - docs: >- - The accounting period that the GeneralLedgerTransaction was generated - in. + type: optional + docs: The accounting period the report was posted in company: - type: optional - docs: The company the GeneralLedgerTransaction belongs to. - remote_updated_at: - type: optional - docs: When the third party's GeneralLedgerTransaction entry was updated. - remote_created_at: - type: optional - docs: When the third party's GeneralLedgerTransaction entry was created. - tracking_categories: optional>> - posting_date: - type: optional - docs: The date that the transaction was posted to the general ledger. - general_ledger_transaction_lines: - type: >- - optional> - docs: A list of “General Ledger Transaction Applied to Lines” objects. - access: read-only - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - field_mappings: + type: optional + docs: The subsidiary that the expense report is created in + tracking_categories: + docs: The related tracking categories associated with the expense report + type: list + integration_params: type: optional> - access: read-only - remote_data: - type: optional> - access: read-only + access: write-only + linked_account_params: + type: optional> + access: write-only + remote_fields: + type: optional> + access: write-only source: openapi: openapi/openapi.yml - GeneralLedgerTransactionLineAccount: - discriminated: false - union: - - type: string - validation: - format: uuid - - Account + ExpenseReportResponse: + properties: + model: ExpenseReport + warnings: list + errors: list + logs: optional> source: openapi: openapi/openapi.yml - inline: true - GeneralLedgerTransactionLineCompany: - discriminated: false - docs: The company the GeneralLedgerTransaction belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo + ExpenseReportStatusEnum: + enum: + - DRAFT + - SUBMITTED + - APPROVED + - REJECTED + docs: |- + * `DRAFT` - DRAFT + * `SUBMITTED` - SUBMITTED + * `APPROVED` - APPROVED + * `REJECTED` - REJECTED source: openapi: openapi/openapi.yml - inline: true - GeneralLedgerTransactionLineEmployee: + ExpenseRequestAccount: discriminated: false + docs: The expense's payment account. union: - type: string validation: format: uuid - - Employee + - Account source: openapi: openapi/openapi.yml inline: true - GeneralLedgerTransactionLineContact: + ExpenseRequestContact: discriminated: false + docs: The expense's contact. union: - type: string validation: @@ -25241,20 +20435,10 @@ types: source: openapi: openapi/openapi.yml inline: true - GeneralLedgerTransactionLineProject: - discriminated: false - union: - - type: string - validation: - format: uuid - - Project - source: - openapi: openapi/openapi.yml - inline: true - GeneralLedgerTransactionLineBaseCurrency: + ExpenseRequestCurrency: discriminated: false docs: >- - The base currency of the transaction + The expense's currency. * `XUA` - ADB Unit of Account @@ -25875,631 +21059,969 @@ types: source: openapi: openapi/openapi.yml inline: true - GeneralLedgerTransactionLineTransactionCurrency: + ExpenseRequestCompany: + discriminated: false + docs: The company the expense belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + ExpenseRequestEmployee: + discriminated: false + docs: The employee this overall transaction relates to. + union: + - type: string + validation: + format: uuid + - Employee + source: + openapi: openapi/openapi.yml + inline: true + ExpenseRequestTrackingCategoriesItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - TrackingCategory + source: + openapi: openapi/openapi.yml + inline: true + ExpenseRequestAccountingPeriod: discriminated: false + docs: The accounting period that the Expense was generated in. + union: + - type: string + validation: + format: uuid + - AccountingPeriod + source: + openapi: openapi/openapi.yml + inline: true + ExpenseRequest: docs: >- - The transaction currency that the transaction is made in. + # The Expense Object + ### Description - * `XUA` - ADB Unit of Account + The `Expense` object is used to represent a direct purchase by a business, + typically made with a check, credit card, or cash. Each `Expense` object + is dedicated to a grouping of expenses, with each expense recorded in the + lines object. - * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) + The `Expense` object is used also used to represent refunds to direct + purchases. Refunds can be distinguished from purchases by the amount sign + of the records. Expense objects with a negative amount are purchases and + `Expense` objects with a positive amount are refunds to those purchases. - * `ALL` - Albanian Lek - * `ALK` - Albanian Lek (1946–1965) + ### Usage Example - * `DZD` - Algerian Dinar + Fetch from the `GET Expense` endpoint and view a company's expense. + properties: + transaction_date: + type: optional + docs: When the transaction occurred. + account: + type: optional + docs: The expense's payment account. + contact: + type: optional + docs: The expense's contact. + total_amount: + type: optional + docs: The expense's total amount. + sub_total: + type: optional + docs: The expense's total amount before tax. + total_tax_amount: + type: optional + docs: The expense's total tax amount. + currency: + type: optional + docs: >- + The expense's currency. - * `ADP` - Andorran Peseta - * `AOA` - Angolan Kwanza + * `XUA` - ADB Unit of Account - * `AOK` - Angolan Kwanza (1977–1991) + * `AFN` - Afghan Afghani - * `AON` - Angolan New Kwanza (1990–2000) + * `AFA` - Afghan Afghani (1927–2002) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `ALL` - Albanian Lek - * `ARA` - Argentine Austral + * `ALK` - Albanian Lek (1946–1965) - * `ARS` - Argentine Peso + * `DZD` - Algerian Dinar - * `ARM` - Argentine Peso (1881–1970) + * `ADP` - Andorran Peseta - * `ARP` - Argentine Peso (1983–1985) + * `AOA` - Angolan Kwanza - * `ARL` - Argentine Peso Ley (1970–1983) + * `AOK` - Angolan Kwanza (1977–1991) - * `AMD` - Armenian Dram + * `AON` - Angolan New Kwanza (1990–2000) - * `AWG` - Aruban Florin + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `AUD` - Australian Dollar + * `ARA` - Argentine Austral - * `ATS` - Austrian Schilling + * `ARS` - Argentine Peso - * `AZN` - Azerbaijani Manat + * `ARM` - Argentine Peso (1881–1970) - * `AZM` - Azerbaijani Manat (1993–2006) + * `ARP` - Argentine Peso (1983–1985) - * `BSD` - Bahamian Dollar + * `ARL` - Argentine Peso Ley (1970–1983) - * `BHD` - Bahraini Dinar + * `AMD` - Armenian Dram - * `BDT` - Bangladeshi Taka + * `AWG` - Aruban Florin - * `BBD` - Barbadian Dollar + * `AUD` - Australian Dollar - * `BYN` - Belarusian Ruble + * `ATS` - Austrian Schilling - * `BYB` - Belarusian Ruble (1994–1999) + * `AZN` - Azerbaijani Manat - * `BYR` - Belarusian Ruble (2000–2016) + * `AZM` - Azerbaijani Manat (1993–2006) - * `BEF` - Belgian Franc + * `BSD` - Bahamian Dollar - * `BEC` - Belgian Franc (convertible) + * `BHD` - Bahraini Dinar - * `BEL` - Belgian Franc (financial) + * `BDT` - Bangladeshi Taka - * `BZD` - Belize Dollar + * `BBD` - Barbadian Dollar + + * `BYN` - Belarusian Ruble + + * `BYB` - Belarusian Ruble (1994–1999) + + * `BYR` - Belarusian Ruble (2000–2016) + + * `BEF` - Belgian Franc + + * `BEC` - Belgian Franc (convertible) + + * `BEL` - Belgian Franc (financial) + + * `BZD` - Belize Dollar + + * `BMD` - Bermudan Dollar - * `BMD` - Bermudan Dollar + * `BTN` - Bhutanese Ngultrum - * `BTN` - Bhutanese Ngultrum + * `BOB` - Bolivian Boliviano - * `BOB` - Bolivian Boliviano + * `BOL` - Bolivian Boliviano (1863–1963) - * `BOL` - Bolivian Boliviano (1863–1963) + * `BOV` - Bolivian Mvdol - * `BOV` - Bolivian Mvdol + * `BOP` - Bolivian Peso - * `BOP` - Bolivian Peso + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `BWP` - Botswanan Pula - * `BWP` - Botswanan Pula + * `BRC` - Brazilian Cruzado (1986–1989) - * `BRC` - Brazilian Cruzado (1986–1989) + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BRN` - Brazilian New Cruzado (1989–1990) + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `BRL` - Brazilian Real - * `BRL` - Brazilian Real + * `GBP` - British Pound - * `GBP` - British Pound + * `BND` - Brunei Dollar - * `BND` - Brunei Dollar + * `BGL` - Bulgarian Hard Lev - * `BGL` - Bulgarian Hard Lev + * `BGN` - Bulgarian Lev - * `BGN` - Bulgarian Lev + * `BGO` - Bulgarian Lev (1879–1952) - * `BGO` - Bulgarian Lev (1879–1952) + * `BGM` - Bulgarian Socialist Lev - * `BGM` - Bulgarian Socialist Lev + * `BUK` - Burmese Kyat - * `BUK` - Burmese Kyat + * `BIF` - Burundian Franc - * `BIF` - Burundian Franc + * `XPF` - CFP Franc - * `XPF` - CFP Franc + * `KHR` - Cambodian Riel - * `KHR` - Cambodian Riel + * `CAD` - Canadian Dollar - * `CAD` - Canadian Dollar + * `CVE` - Cape Verdean Escudo - * `CVE` - Cape Verdean Escudo + * `KYD` - Cayman Islands Dollar - * `KYD` - Cayman Islands Dollar + * `XAF` - Central African CFA Franc - * `XAF` - Central African CFA Franc + * `CLE` - Chilean Escudo - * `CLE` - Chilean Escudo + * `CLP` - Chilean Peso - * `CLP` - Chilean Peso + * `CLF` - Chilean Unit of Account (UF) - * `CLF` - Chilean Unit of Account (UF) + * `CNX` - Chinese People’s Bank Dollar - * `CNX` - Chinese People’s Bank Dollar + * `CNY` - Chinese Yuan - * `CNY` - Chinese Yuan + * `CNH` - Chinese Yuan (offshore) - * `CNH` - Chinese Yuan (offshore) + * `COP` - Colombian Peso - * `COP` - Colombian Peso + * `COU` - Colombian Real Value Unit - * `COU` - Colombian Real Value Unit + * `KMF` - Comorian Franc - * `KMF` - Comorian Franc + * `CDF` - Congolese Franc - * `CDF` - Congolese Franc + * `CRC` - Costa Rican Colón - * `CRC` - Costa Rican Colón + * `HRD` - Croatian Dinar - * `HRD` - Croatian Dinar + * `HRK` - Croatian Kuna - * `HRK` - Croatian Kuna + * `CUC` - Cuban Convertible Peso - * `CUC` - Cuban Convertible Peso + * `CUP` - Cuban Peso - * `CUP` - Cuban Peso + * `CYP` - Cypriot Pound - * `CYP` - Cypriot Pound + * `CZK` - Czech Koruna - * `CZK` - Czech Koruna + * `CSK` - Czechoslovak Hard Koruna - * `CSK` - Czechoslovak Hard Koruna + * `DKK` - Danish Krone - * `DKK` - Danish Krone + * `DJF` - Djiboutian Franc - * `DJF` - Djiboutian Franc + * `DOP` - Dominican Peso - * `DOP` - Dominican Peso + * `NLG` - Dutch Guilder - * `NLG` - Dutch Guilder + * `XCD` - East Caribbean Dollar - * `XCD` - East Caribbean Dollar + * `DDM` - East German Mark - * `DDM` - East German Mark + * `ECS` - Ecuadorian Sucre - * `ECS` - Ecuadorian Sucre + * `ECV` - Ecuadorian Unit of Constant Value - * `ECV` - Ecuadorian Unit of Constant Value + * `EGP` - Egyptian Pound - * `EGP` - Egyptian Pound + * `GQE` - Equatorial Guinean Ekwele - * `GQE` - Equatorial Guinean Ekwele + * `ERN` - Eritrean Nakfa - * `ERN` - Eritrean Nakfa + * `EEK` - Estonian Kroon - * `EEK` - Estonian Kroon + * `ETB` - Ethiopian Birr - * `ETB` - Ethiopian Birr + * `EUR` - Euro - * `EUR` - Euro + * `XBA` - European Composite Unit - * `XBA` - European Composite Unit + * `XEU` - European Currency Unit - * `XEU` - European Currency Unit + * `XBB` - European Monetary Unit - * `XBB` - European Monetary Unit + * `XBC` - European Unit of Account (XBC) - * `XBC` - European Unit of Account (XBC) + * `XBD` - European Unit of Account (XBD) - * `XBD` - European Unit of Account (XBD) + * `FKP` - Falkland Islands Pound - * `FKP` - Falkland Islands Pound + * `FJD` - Fijian Dollar - * `FJD` - Fijian Dollar + * `FIM` - Finnish Markka - * `FIM` - Finnish Markka + * `FRF` - French Franc - * `FRF` - French Franc + * `XFO` - French Gold Franc - * `XFO` - French Gold Franc + * `XFU` - French UIC-Franc - * `XFU` - French UIC-Franc + * `GMD` - Gambian Dalasi - * `GMD` - Gambian Dalasi + * `GEK` - Georgian Kupon Larit - * `GEK` - Georgian Kupon Larit + * `GEL` - Georgian Lari - * `GEL` - Georgian Lari + * `DEM` - German Mark - * `DEM` - German Mark + * `GHS` - Ghanaian Cedi - * `GHS` - Ghanaian Cedi + * `GHC` - Ghanaian Cedi (1979–2007) - * `GHC` - Ghanaian Cedi (1979–2007) + * `GIP` - Gibraltar Pound - * `GIP` - Gibraltar Pound + * `XAU` - Gold - * `XAU` - Gold + * `GRD` - Greek Drachma - * `GRD` - Greek Drachma + * `GTQ` - Guatemalan Quetzal - * `GTQ` - Guatemalan Quetzal + * `GWP` - Guinea-Bissau Peso - * `GWP` - Guinea-Bissau Peso + * `GNF` - Guinean Franc - * `GNF` - Guinean Franc + * `GNS` - Guinean Syli - * `GNS` - Guinean Syli + * `GYD` - Guyanaese Dollar - * `GYD` - Guyanaese Dollar + * `HTG` - Haitian Gourde - * `HTG` - Haitian Gourde + * `HNL` - Honduran Lempira - * `HNL` - Honduran Lempira + * `HKD` - Hong Kong Dollar - * `HKD` - Hong Kong Dollar + * `HUF` - Hungarian Forint - * `HUF` - Hungarian Forint + * `IMP` - IMP - * `IMP` - IMP + * `ISK` - Icelandic Króna - * `ISK` - Icelandic Króna + * `ISJ` - Icelandic Króna (1918–1981) - * `ISJ` - Icelandic Króna (1918–1981) + * `INR` - Indian Rupee - * `INR` - Indian Rupee + * `IDR` - Indonesian Rupiah - * `IDR` - Indonesian Rupiah + * `IRR` - Iranian Rial - * `IRR` - Iranian Rial + * `IQD` - Iraqi Dinar - * `IQD` - Iraqi Dinar + * `IEP` - Irish Pound - * `IEP` - Irish Pound + * `ILS` - Israeli New Shekel - * `ILS` - Israeli New Shekel + * `ILP` - Israeli Pound - * `ILP` - Israeli Pound + * `ILR` - Israeli Shekel (1980–1985) - * `ILR` - Israeli Shekel (1980–1985) + * `ITL` - Italian Lira - * `ITL` - Italian Lira + * `JMD` - Jamaican Dollar - * `JMD` - Jamaican Dollar + * `JPY` - Japanese Yen - * `JPY` - Japanese Yen + * `JOD` - Jordanian Dinar - * `JOD` - Jordanian Dinar + * `KZT` - Kazakhstani Tenge - * `KZT` - Kazakhstani Tenge + * `KES` - Kenyan Shilling - * `KES` - Kenyan Shilling + * `KWD` - Kuwaiti Dinar - * `KWD` - Kuwaiti Dinar + * `KGS` - Kyrgystani Som - * `KGS` - Kyrgystani Som + * `LAK` - Laotian Kip - * `LAK` - Laotian Kip + * `LVL` - Latvian Lats - * `LVL` - Latvian Lats + * `LVR` - Latvian Ruble - * `LVR` - Latvian Ruble + * `LBP` - Lebanese Pound - * `LBP` - Lebanese Pound + * `LSL` - Lesotho Loti - * `LSL` - Lesotho Loti + * `LRD` - Liberian Dollar - * `LRD` - Liberian Dollar + * `LYD` - Libyan Dinar - * `LYD` - Libyan Dinar + * `LTL` - Lithuanian Litas - * `LTL` - Lithuanian Litas + * `LTT` - Lithuanian Talonas - * `LTT` - Lithuanian Talonas + * `LUL` - Luxembourg Financial Franc - * `LUL` - Luxembourg Financial Franc + * `LUC` - Luxembourgian Convertible Franc - * `LUC` - Luxembourgian Convertible Franc + * `LUF` - Luxembourgian Franc - * `LUF` - Luxembourgian Franc + * `MOP` - Macanese Pataca - * `MOP` - Macanese Pataca + * `MKD` - Macedonian Denar - * `MKD` - Macedonian Denar + * `MKN` - Macedonian Denar (1992–1993) - * `MKN` - Macedonian Denar (1992–1993) + * `MGA` - Malagasy Ariary - * `MGA` - Malagasy Ariary + * `MGF` - Malagasy Franc - * `MGF` - Malagasy Franc + * `MWK` - Malawian Kwacha - * `MWK` - Malawian Kwacha + * `MYR` - Malaysian Ringgit - * `MYR` - Malaysian Ringgit + * `MVR` - Maldivian Rufiyaa - * `MVR` - Maldivian Rufiyaa + * `MVP` - Maldivian Rupee (1947–1981) - * `MVP` - Maldivian Rupee (1947–1981) + * `MLF` - Malian Franc - * `MLF` - Malian Franc + * `MTL` - Maltese Lira - * `MTL` - Maltese Lira + * `MTP` - Maltese Pound - * `MTP` - Maltese Pound + * `MRU` - Mauritanian Ouguiya - * `MRU` - Mauritanian Ouguiya + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `MUR` - Mauritian Rupee - * `MUR` - Mauritian Rupee + * `MXV` - Mexican Investment Unit - * `MXV` - Mexican Investment Unit + * `MXN` - Mexican Peso - * `MXN` - Mexican Peso + * `MXP` - Mexican Silver Peso (1861–1992) - * `MXP` - Mexican Silver Peso (1861–1992) + * `MDC` - Moldovan Cupon - * `MDC` - Moldovan Cupon + * `MDL` - Moldovan Leu - * `MDL` - Moldovan Leu + * `MCF` - Monegasque Franc - * `MCF` - Monegasque Franc + * `MNT` - Mongolian Tugrik - * `MNT` - Mongolian Tugrik + * `MAD` - Moroccan Dirham - * `MAD` - Moroccan Dirham + * `MAF` - Moroccan Franc - * `MAF` - Moroccan Franc + * `MZE` - Mozambican Escudo - * `MZE` - Mozambican Escudo + * `MZN` - Mozambican Metical - * `MZN` - Mozambican Metical + * `MZM` - Mozambican Metical (1980–2006) - * `MZM` - Mozambican Metical (1980–2006) + * `MMK` - Myanmar Kyat - * `MMK` - Myanmar Kyat + * `NAD` - Namibian Dollar - * `NAD` - Namibian Dollar + * `NPR` - Nepalese Rupee - * `NPR` - Nepalese Rupee + * `ANG` - Netherlands Antillean Guilder - * `ANG` - Netherlands Antillean Guilder + * `TWD` - New Taiwan Dollar - * `TWD` - New Taiwan Dollar + * `NZD` - New Zealand Dollar - * `NZD` - New Zealand Dollar + * `NIO` - Nicaraguan Córdoba - * `NIO` - Nicaraguan Córdoba + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `NGN` - Nigerian Naira - * `NGN` - Nigerian Naira + * `KPW` - North Korean Won - * `KPW` - North Korean Won + * `NOK` - Norwegian Krone - * `NOK` - Norwegian Krone + * `OMR` - Omani Rial - * `OMR` - Omani Rial + * `PKR` - Pakistani Rupee - * `PKR` - Pakistani Rupee + * `XPD` - Palladium - * `XPD` - Palladium + * `PAB` - Panamanian Balboa - * `PAB` - Panamanian Balboa + * `PGK` - Papua New Guinean Kina - * `PGK` - Papua New Guinean Kina + * `PYG` - Paraguayan Guarani - * `PYG` - Paraguayan Guarani + * `PEI` - Peruvian Inti - * `PEI` - Peruvian Inti + * `PEN` - Peruvian Sol - * `PEN` - Peruvian Sol + * `PES` - Peruvian Sol (1863–1965) - * `PES` - Peruvian Sol (1863–1965) + * `PHP` - Philippine Peso - * `PHP` - Philippine Peso + * `XPT` - Platinum - * `XPT` - Platinum + * `PLN` - Polish Zloty - * `PLN` - Polish Zloty + * `PLZ` - Polish Zloty (1950–1995) - * `PLZ` - Polish Zloty (1950–1995) + * `PTE` - Portuguese Escudo - * `PTE` - Portuguese Escudo + * `GWE` - Portuguese Guinea Escudo - * `GWE` - Portuguese Guinea Escudo + * `QAR` - Qatari Rial - * `QAR` - Qatari Rial + * `XRE` - RINET Funds - * `XRE` - RINET Funds + * `RHD` - Rhodesian Dollar - * `RHD` - Rhodesian Dollar + * `RON` - Romanian Leu - * `RON` - Romanian Leu + * `ROL` - Romanian Leu (1952–2006) - * `ROL` - Romanian Leu (1952–2006) + * `RUB` - Russian Ruble - * `RUB` - Russian Ruble + * `RUR` - Russian Ruble (1991–1998) - * `RUR` - Russian Ruble (1991–1998) + * `RWF` - Rwandan Franc - * `RWF` - Rwandan Franc + * `SVC` - Salvadoran Colón - * `SVC` - Salvadoran Colón + * `WST` - Samoan Tala - * `WST` - Samoan Tala + * `SAR` - Saudi Riyal - * `SAR` - Saudi Riyal + * `RSD` - Serbian Dinar - * `RSD` - Serbian Dinar + * `CSD` - Serbian Dinar (2002–2006) - * `CSD` - Serbian Dinar (2002–2006) + * `SCR` - Seychellois Rupee - * `SCR` - Seychellois Rupee + * `SLL` - Sierra Leonean Leone - * `SLL` - Sierra Leonean Leone + * `XAG` - Silver - * `XAG` - Silver + * `SGD` - Singapore Dollar - * `SGD` - Singapore Dollar + * `SKK` - Slovak Koruna - * `SKK` - Slovak Koruna + * `SIT` - Slovenian Tolar - * `SIT` - Slovenian Tolar + * `SBD` - Solomon Islands Dollar - * `SBD` - Solomon Islands Dollar + * `SOS` - Somali Shilling - * `SOS` - Somali Shilling + * `ZAR` - South African Rand - * `ZAR` - South African Rand + * `ZAL` - South African Rand (financial) - * `ZAL` - South African Rand (financial) + * `KRH` - South Korean Hwan (1953–1962) - * `KRH` - South Korean Hwan (1953–1962) + * `KRW` - South Korean Won - * `KRW` - South Korean Won + * `KRO` - South Korean Won (1945–1953) - * `KRO` - South Korean Won (1945–1953) + * `SSP` - South Sudanese Pound - * `SSP` - South Sudanese Pound + * `SUR` - Soviet Rouble - * `SUR` - Soviet Rouble + * `ESP` - Spanish Peseta - * `ESP` - Spanish Peseta + * `ESA` - Spanish Peseta (A account) - * `ESA` - Spanish Peseta (A account) + * `ESB` - Spanish Peseta (convertible account) - * `ESB` - Spanish Peseta (convertible account) + * `XDR` - Special Drawing Rights - * `XDR` - Special Drawing Rights + * `LKR` - Sri Lankan Rupee - * `LKR` - Sri Lankan Rupee + * `SHP` - St. Helena Pound - * `SHP` - St. Helena Pound + * `XSU` - Sucre - * `XSU` - Sucre + * `SDD` - Sudanese Dinar (1992–2007) - * `SDD` - Sudanese Dinar (1992–2007) + * `SDG` - Sudanese Pound - * `SDG` - Sudanese Pound + * `SDP` - Sudanese Pound (1957–1998) - * `SDP` - Sudanese Pound (1957–1998) + * `SRD` - Surinamese Dollar - * `SRD` - Surinamese Dollar + * `SRG` - Surinamese Guilder - * `SRG` - Surinamese Guilder + * `SZL` - Swazi Lilangeni - * `SZL` - Swazi Lilangeni + * `SEK` - Swedish Krona - * `SEK` - Swedish Krona + * `CHF` - Swiss Franc - * `CHF` - Swiss Franc + * `SYP` - Syrian Pound - * `SYP` - Syrian Pound + * `STN` - São Tomé & Príncipe Dobra - * `STN` - São Tomé & Príncipe Dobra + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `TVD` - TVD - * `TVD` - TVD + * `TJR` - Tajikistani Ruble - * `TJR` - Tajikistani Ruble + * `TJS` - Tajikistani Somoni - * `TJS` - Tajikistani Somoni + * `TZS` - Tanzanian Shilling - * `TZS` - Tanzanian Shilling + * `XTS` - Testing Currency Code - * `XTS` - Testing Currency Code + * `THB` - Thai Baht - * `THB` - Thai Baht + * `XXX` - The codes assigned for transactions where no currency is + involved - * `XXX` - The codes assigned for transactions where no currency is - involved + * `TPE` - Timorese Escudo - * `TPE` - Timorese Escudo + * `TOP` - Tongan Paʻanga - * `TOP` - Tongan Paʻanga + * `TTD` - Trinidad & Tobago Dollar - * `TTD` - Trinidad & Tobago Dollar + * `TND` - Tunisian Dinar - * `TND` - Tunisian Dinar + * `TRY` - Turkish Lira - * `TRY` - Turkish Lira + * `TRL` - Turkish Lira (1922–2005) - * `TRL` - Turkish Lira (1922–2005) + * `TMT` - Turkmenistani Manat - * `TMT` - Turkmenistani Manat + * `TMM` - Turkmenistani Manat (1993–2009) - * `TMM` - Turkmenistani Manat (1993–2009) + * `USD` - US Dollar - * `USD` - US Dollar + * `USN` - US Dollar (Next day) - * `USN` - US Dollar (Next day) + * `USS` - US Dollar (Same day) - * `USS` - US Dollar (Same day) + * `UGX` - Ugandan Shilling - * `UGX` - Ugandan Shilling + * `UGS` - Ugandan Shilling (1966–1987) - * `UGS` - Ugandan Shilling (1966–1987) + * `UAH` - Ukrainian Hryvnia - * `UAH` - Ukrainian Hryvnia + * `UAK` - Ukrainian Karbovanets - * `UAK` - Ukrainian Karbovanets + * `AED` - United Arab Emirates Dirham - * `AED` - United Arab Emirates Dirham + * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYW` - Uruguayan Nominal Wage Index Unit + * `UYU` - Uruguayan Peso - * `UYU` - Uruguayan Peso + * `UYP` - Uruguayan Peso (1975–1993) - * `UYP` - Uruguayan Peso (1975–1993) + * `UYI` - Uruguayan Peso (Indexed Units) - * `UYI` - Uruguayan Peso (Indexed Units) + * `UZS` - Uzbekistani Som - * `UZS` - Uzbekistani Som + * `VUV` - Vanuatu Vatu - * `VUV` - Vanuatu Vatu + * `VES` - Venezuelan Bolívar - * `VES` - Venezuelan Bolívar + * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEB` - Venezuelan Bolívar (1871–2008) + * `VEF` - Venezuelan Bolívar (2008–2018) - * `VEF` - Venezuelan Bolívar (2008–2018) + * `VND` - Vietnamese Dong - * `VND` - Vietnamese Dong + * `VNN` - Vietnamese Dong (1978–1985) - * `VNN` - Vietnamese Dong (1978–1985) + * `CHE` - WIR Euro - * `CHE` - WIR Euro + * `CHW` - WIR Franc - * `CHW` - WIR Franc + * `XOF` - West African CFA Franc - * `XOF` - West African CFA Franc + * `YDD` - Yemeni Dinar - * `YDD` - Yemeni Dinar + * `YER` - Yemeni Rial - * `YER` - Yemeni Rial + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `ZWN` - ZWN - * `ZWN` - ZWN + * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRN` - Zairean New Zaire (1993–1998) + * `ZRZ` - Zairean Zaire (1971–1993) - * `ZRZ` - Zairean Zaire (1971–1993) + * `ZMW` - Zambian Kwacha - * `ZMW` - Zambian Kwacha + * `ZMK` - Zambian Kwacha (1968–2012) - * `ZMK` - Zambian Kwacha (1968–2012) + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `ZWR` - Zimbabwean Dollar (2008) - * `ZWR` - Zimbabwean Dollar (2008) + * `ZWL` - Zimbabwean Dollar (2009) + exchange_rate: + type: optional + docs: The expense's exchange rate. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + inclusive_of_tax: + type: optional + docs: >- + If the transaction is inclusive or exclusive of tax. `True` if + inclusive, `False` if exclusive. + company: + type: optional + docs: The company the expense belongs to. + employee: + type: optional + docs: The employee this overall transaction relates to. + memo: + type: optional + docs: The expense's private note. + lines: optional> + tracking_categories: optional>> + accounting_period: + type: optional + docs: The accounting period that the Expense was generated in. + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + remote_fields: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + ExpenseResponse: + properties: + model: Expense + warnings: list + errors: list + logs: optional> + source: + openapi: openapi/openapi.yml + ExternalTargetFieldApi: + properties: + name: + type: optional + access: read-only + description: + type: optional + access: read-only + is_mapped: + type: optional + access: read-only + source: + openapi: openapi/openapi.yml + ExternalTargetFieldApiResponse: + properties: + Account: optional> + AccountingAttachment: optional> + BalanceSheet: optional> + CashFlowStatement: optional> + CompanyInfo: optional> + Contact: optional> + IncomeStatement: optional> + CreditNote: optional> + Item: optional> + PurchaseOrder: optional> + ExpenseReport: optional> + TrackingCategory: optional> + JournalEntry: optional> + TaxRate: optional> + Invoice: optional> + Payment: optional> + Expense: optional> + VendorCredit: optional> + Transaction: optional> + AccountingPeriod: optional> + GeneralLedgerTransaction: optional> + BankFeedAccount: optional> + Employee: optional> + PaymentMethod: optional> + Project: optional> + PaymentTerm: optional> + source: + openapi: openapi/openapi.yml + FeedStatusEnum: + enum: + - ACTIVE + - INACTIVE + docs: |- + * `ACTIVE` - ACTIVE + * `INACTIVE` - INACTIVE + source: + openapi: openapi/openapi.yml + FieldFormatEnum: + enum: + - string + - number + - date + - datetime + - bool + - list + docs: |- + * `string` - string + * `number` - number + * `date` - date + * `datetime` - datetime + * `bool` - bool + * `list` - list + source: + openapi: openapi/openapi.yml + FieldMappingApiInstanceTargetField: + properties: + name: string + description: string + is_organization_wide: boolean + source: + openapi: openapi/openapi.yml + inline: true + FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo: + properties: + method: optional + url_path: optional + field_traversal_path: optional> + source: + openapi: openapi/openapi.yml + inline: true + FieldMappingApiInstanceRemoteField: + properties: + remote_key_name: optional + schema: optional> + remote_endpoint_info: FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo + source: + openapi: openapi/openapi.yml + inline: true + FieldMappingApiInstance: + properties: + id: + type: optional + validation: + format: uuid + access: read-only + is_integration_wide: + type: optional + access: read-only + target_field: + type: optional + access: read-only + remote_field: + type: optional + access: read-only + source: + openapi: openapi/openapi.yml + FieldMappingApiInstanceResponse: + properties: + Account: optional> + AccountingAttachment: optional> + BalanceSheet: optional> + CashFlowStatement: optional> + CompanyInfo: optional> + Contact: optional> + IncomeStatement: optional> + CreditNote: optional> + Item: optional> + PurchaseOrder: optional> + ExpenseReport: optional> + TrackingCategory: optional> + JournalEntry: optional> + TaxRate: optional> + Invoice: optional> + Payment: optional> + Expense: optional> + VendorCredit: optional> + Transaction: optional> + AccountingPeriod: optional> + GeneralLedgerTransaction: optional> + BankFeedAccount: optional> + Employee: optional> + PaymentMethod: optional> + Project: optional> + PaymentTerm: optional> + source: + openapi: openapi/openapi.yml + FieldMappingInstanceResponse: + properties: + model: FieldMappingApiInstance + warnings: list + errors: list + logs: optional> + source: + openapi: openapi/openapi.yml + FieldPermissionDeserializer: + properties: + enabled_fields: optional> + disabled_fields: optional> + source: + openapi: openapi/openapi.yml + FieldPermissionDeserializerRequest: + properties: + enabled_fields: optional> + disabled_fields: optional> + source: + openapi: openapi/openapi.yml + FieldTypeEnum: + enum: + - string + - number + - date + - datetime + - bool + - list + docs: |- + * `string` - string + * `number` - number + * `date` - date + * `datetime` - datetime + * `bool` - bool + * `list` - list + source: + openapi: openapi/openapi.yml + GeneralLedgerTransactionUnderlyingTransactionType: + discriminated: false + docs: |- + The type of the underlying transaction. - * `ZWL` - Zimbabwean Dollar (2009) + * `INVOICE` - INVOICE + * `EXPENSE` - EXPENSE + * `TRANSACTION` - TRANSACTION + * `JOURNAL_ENTRY` - JOURNAL_ENTRY + * `PAYMENT` - PAYMENT + * `VENDOR_CREDIT` - VENDOR_CREDIT + * `CREDIT_NOTE` - CREDIT_NOTE union: - - TransactionCurrencyEnum + - UnderlyingTransactionTypeEnum - string source: openapi: openapi/openapi.yml inline: true - GeneralLedgerTransactionLineTrackingCategoriesItem: + GeneralLedgerTransactionAccountingPeriod: + discriminated: false + docs: The accounting period that the GeneralLedgerTransaction was generated in. + union: + - type: string + validation: + format: uuid + - AccountingPeriod + source: + openapi: openapi/openapi.yml + inline: true + GeneralLedgerTransactionCompany: + discriminated: false + docs: The company the GeneralLedgerTransaction belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + GeneralLedgerTransactionTrackingCategoriesItem: discriminated: false union: - type: string @@ -26509,30 +22031,42 @@ types: source: openapi: openapi/openapi.yml inline: true - GeneralLedgerTransactionLineItem: + GeneralLedgerTransactionGeneralLedgerTransactionLinesItem: discriminated: false union: - type: string validation: format: uuid - - Item + - GeneralLedgerTransactionLine source: openapi: openapi/openapi.yml inline: true - GeneralLedgerTransactionLine: + GeneralLedgerTransaction: docs: >- - # The GeneralLedgerTransactionLineSerializer Object + # The GeneralLedgerTransaction Object ### Description - The `GeneralLedgerTransactionLineSerializer` object represents general - ledger transaction line item. + A General Ledger Entry is a record of a financial transaction that is + posted to the general ledger, the central repository of a company’s + financial data. - ### Usage Example Fetch from the `GET - GeneralLedgerTransactionLineSerializer` endpoint and view an + The `GeneralLedgerTransaction` object is a singular endpoint to pull all + transactions posted to a company’s general ledger. The transaction that + generated the `GeneralLedgerTransaction` can be found by referencing the + `underlying_transaction_type` and `underlying_transaction_remote_id` + fields. - `GeneralLedgerTransaction` line item. + + The lines of a `GeneralLedgerTransaction` object will always have equal + amounts of debits and credits. + + + ### Usage Example + + Fetch from the `GET GeneralLedgerTransaction` endpoint and view a general + ledger transaction. properties: id: type: optional @@ -26550,1957 +22084,2042 @@ types: type: optional docs: The datetime that this object was modified by Merge. access: read-only - account: optional + underlying_transaction_remote_id: + type: optional + docs: The third party remote ID of the underlying transaction. + validation: + maxLength: 50 + underlying_transaction_type: + type: optional + docs: |- + The type of the underlying transaction. + + * `INVOICE` - INVOICE + * `EXPENSE` - EXPENSE + * `TRANSACTION` - TRANSACTION + * `JOURNAL_ENTRY` - JOURNAL_ENTRY + * `PAYMENT` - PAYMENT + * `VENDOR_CREDIT` - VENDOR_CREDIT + * `CREDIT_NOTE` - CREDIT_NOTE + accounting_period: + type: optional + docs: >- + The accounting period that the GeneralLedgerTransaction was generated + in. company: - type: optional + type: optional docs: The company the GeneralLedgerTransaction belongs to. - employee: optional - contact: optional - project: optional - base_currency: - type: optional + remote_updated_at: + type: optional + docs: When the third party's GeneralLedgerTransaction entry was updated. + remote_created_at: + type: optional + docs: When the third party's GeneralLedgerTransaction entry was created. + tracking_categories: optional>> + posting_date: + type: optional + docs: The date that the transaction was posted to the general ledger. + general_ledger_transaction_lines: + type: >- + optional> + docs: A list of “General Ledger Transaction Applied to Lines” objects. + access: read-only + remote_was_deleted: + type: optional docs: >- - The base currency of the transaction + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + GeneralLedgerTransactionLineAccount: + discriminated: false + union: + - type: string + validation: + format: uuid + - Account + source: + openapi: openapi/openapi.yml + inline: true + GeneralLedgerTransactionLineCompany: + discriminated: false + docs: The company the GeneralLedgerTransaction belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + GeneralLedgerTransactionLineEmployee: + discriminated: false + union: + - type: string + validation: + format: uuid + - Employee + source: + openapi: openapi/openapi.yml + inline: true + GeneralLedgerTransactionLineContact: + discriminated: false + union: + - type: string + validation: + format: uuid + - Contact + source: + openapi: openapi/openapi.yml + inline: true + GeneralLedgerTransactionLineProject: + discriminated: false + union: + - type: string + validation: + format: uuid + - Project + source: + openapi: openapi/openapi.yml + inline: true + GeneralLedgerTransactionLineBaseCurrency: + discriminated: false + docs: >- + The base currency of the transaction - * `XUA` - ADB Unit of Account + * `XUA` - ADB Unit of Account - * `AFN` - Afghan Afghani + * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) + * `AFA` - Afghan Afghani (1927–2002) - * `ALL` - Albanian Lek + * `ALL` - Albanian Lek - * `ALK` - Albanian Lek (1946–1965) + * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar + * `DZD` - Algerian Dinar - * `ADP` - Andorran Peseta + * `ADP` - Andorran Peseta - * `AOA` - Angolan Kwanza + * `AOA` - Angolan Kwanza - * `AOK` - Angolan Kwanza (1977–1991) + * `AOK` - Angolan Kwanza (1977–1991) - * `AON` - Angolan New Kwanza (1990–2000) + * `AON` - Angolan New Kwanza (1990–2000) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `ARA` - Argentine Austral + * `ARA` - Argentine Austral - * `ARS` - Argentine Peso + * `ARS` - Argentine Peso - * `ARM` - Argentine Peso (1881–1970) + * `ARM` - Argentine Peso (1881–1970) - * `ARP` - Argentine Peso (1983–1985) + * `ARP` - Argentine Peso (1983–1985) - * `ARL` - Argentine Peso Ley (1970–1983) + * `ARL` - Argentine Peso Ley (1970–1983) - * `AMD` - Armenian Dram + * `AMD` - Armenian Dram - * `AWG` - Aruban Florin + * `AWG` - Aruban Florin - * `AUD` - Australian Dollar + * `AUD` - Australian Dollar - * `ATS` - Austrian Schilling + * `ATS` - Austrian Schilling - * `AZN` - Azerbaijani Manat + * `AZN` - Azerbaijani Manat - * `AZM` - Azerbaijani Manat (1993–2006) + * `AZM` - Azerbaijani Manat (1993–2006) - * `BSD` - Bahamian Dollar + * `BSD` - Bahamian Dollar - * `BHD` - Bahraini Dinar + * `BHD` - Bahraini Dinar - * `BDT` - Bangladeshi Taka + * `BDT` - Bangladeshi Taka - * `BBD` - Barbadian Dollar + * `BBD` - Barbadian Dollar - * `BYN` - Belarusian Ruble + * `BYN` - Belarusian Ruble - * `BYB` - Belarusian Ruble (1994–1999) + * `BYB` - Belarusian Ruble (1994–1999) - * `BYR` - Belarusian Ruble (2000–2016) + * `BYR` - Belarusian Ruble (2000–2016) - * `BEF` - Belgian Franc + * `BEF` - Belgian Franc - * `BEC` - Belgian Franc (convertible) + * `BEC` - Belgian Franc (convertible) - * `BEL` - Belgian Franc (financial) + * `BEL` - Belgian Franc (financial) - * `BZD` - Belize Dollar + * `BZD` - Belize Dollar - * `BMD` - Bermudan Dollar + * `BMD` - Bermudan Dollar - * `BTN` - Bhutanese Ngultrum + * `BTN` - Bhutanese Ngultrum - * `BOB` - Bolivian Boliviano + * `BOB` - Bolivian Boliviano - * `BOL` - Bolivian Boliviano (1863–1963) + * `BOL` - Bolivian Boliviano (1863–1963) - * `BOV` - Bolivian Mvdol + * `BOV` - Bolivian Mvdol - * `BOP` - Bolivian Peso + * `BOP` - Bolivian Peso - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BWP` - Botswanan Pula + * `BWP` - Botswanan Pula - * `BRC` - Brazilian Cruzado (1986–1989) + * `BRC` - Brazilian Cruzado (1986–1989) - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BRN` - Brazilian New Cruzado (1989–1990) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BRL` - Brazilian Real + * `BRL` - Brazilian Real - * `GBP` - British Pound + * `GBP` - British Pound - * `BND` - Brunei Dollar + * `BND` - Brunei Dollar - * `BGL` - Bulgarian Hard Lev + * `BGL` - Bulgarian Hard Lev - * `BGN` - Bulgarian Lev + * `BGN` - Bulgarian Lev - * `BGO` - Bulgarian Lev (1879–1952) + * `BGO` - Bulgarian Lev (1879–1952) - * `BGM` - Bulgarian Socialist Lev + * `BGM` - Bulgarian Socialist Lev - * `BUK` - Burmese Kyat + * `BUK` - Burmese Kyat - * `BIF` - Burundian Franc + * `BIF` - Burundian Franc - * `XPF` - CFP Franc + * `XPF` - CFP Franc - * `KHR` - Cambodian Riel + * `KHR` - Cambodian Riel - * `CAD` - Canadian Dollar + * `CAD` - Canadian Dollar - * `CVE` - Cape Verdean Escudo + * `CVE` - Cape Verdean Escudo - * `KYD` - Cayman Islands Dollar + * `KYD` - Cayman Islands Dollar - * `XAF` - Central African CFA Franc + * `XAF` - Central African CFA Franc - * `CLE` - Chilean Escudo + * `CLE` - Chilean Escudo - * `CLP` - Chilean Peso + * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) + * `CLF` - Chilean Unit of Account (UF) - * `CNX` - Chinese People’s Bank Dollar + * `CNX` - Chinese People’s Bank Dollar - * `CNY` - Chinese Yuan + * `CNY` - Chinese Yuan - * `CNH` - Chinese Yuan (offshore) + * `CNH` - Chinese Yuan (offshore) - * `COP` - Colombian Peso + * `COP` - Colombian Peso - * `COU` - Colombian Real Value Unit + * `COU` - Colombian Real Value Unit - * `KMF` - Comorian Franc + * `KMF` - Comorian Franc - * `CDF` - Congolese Franc + * `CDF` - Congolese Franc - * `CRC` - Costa Rican Colón + * `CRC` - Costa Rican Colón - * `HRD` - Croatian Dinar + * `HRD` - Croatian Dinar - * `HRK` - Croatian Kuna + * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso + * `CUC` - Cuban Convertible Peso - * `CUP` - Cuban Peso + * `CUP` - Cuban Peso - * `CYP` - Cypriot Pound + * `CYP` - Cypriot Pound - * `CZK` - Czech Koruna + * `CZK` - Czech Koruna - * `CSK` - Czechoslovak Hard Koruna + * `CSK` - Czechoslovak Hard Koruna - * `DKK` - Danish Krone + * `DKK` - Danish Krone - * `DJF` - Djiboutian Franc + * `DJF` - Djiboutian Franc - * `DOP` - Dominican Peso + * `DOP` - Dominican Peso - * `NLG` - Dutch Guilder + * `NLG` - Dutch Guilder - * `XCD` - East Caribbean Dollar + * `XCD` - East Caribbean Dollar - * `DDM` - East German Mark + * `DDM` - East German Mark - * `ECS` - Ecuadorian Sucre + * `ECS` - Ecuadorian Sucre - * `ECV` - Ecuadorian Unit of Constant Value + * `ECV` - Ecuadorian Unit of Constant Value - * `EGP` - Egyptian Pound + * `EGP` - Egyptian Pound - * `GQE` - Equatorial Guinean Ekwele + * `GQE` - Equatorial Guinean Ekwele - * `ERN` - Eritrean Nakfa + * `ERN` - Eritrean Nakfa - * `EEK` - Estonian Kroon + * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr + * `ETB` - Ethiopian Birr - * `EUR` - Euro + * `EUR` - Euro - * `XBA` - European Composite Unit + * `XBA` - European Composite Unit - * `XEU` - European Currency Unit + * `XEU` - European Currency Unit - * `XBB` - European Monetary Unit + * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) + * `XBC` - European Unit of Account (XBC) - * `XBD` - European Unit of Account (XBD) + * `XBD` - European Unit of Account (XBD) - * `FKP` - Falkland Islands Pound + * `FKP` - Falkland Islands Pound - * `FJD` - Fijian Dollar + * `FJD` - Fijian Dollar - * `FIM` - Finnish Markka + * `FIM` - Finnish Markka - * `FRF` - French Franc + * `FRF` - French Franc - * `XFO` - French Gold Franc + * `XFO` - French Gold Franc - * `XFU` - French UIC-Franc + * `XFU` - French UIC-Franc - * `GMD` - Gambian Dalasi + * `GMD` - Gambian Dalasi - * `GEK` - Georgian Kupon Larit + * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari + * `GEL` - Georgian Lari - * `DEM` - German Mark + * `DEM` - German Mark - * `GHS` - Ghanaian Cedi + * `GHS` - Ghanaian Cedi - * `GHC` - Ghanaian Cedi (1979–2007) + * `GHC` - Ghanaian Cedi (1979–2007) - * `GIP` - Gibraltar Pound + * `GIP` - Gibraltar Pound - * `XAU` - Gold + * `XAU` - Gold - * `GRD` - Greek Drachma + * `GRD` - Greek Drachma - * `GTQ` - Guatemalan Quetzal + * `GTQ` - Guatemalan Quetzal - * `GWP` - Guinea-Bissau Peso + * `GWP` - Guinea-Bissau Peso - * `GNF` - Guinean Franc + * `GNF` - Guinean Franc - * `GNS` - Guinean Syli + * `GNS` - Guinean Syli - * `GYD` - Guyanaese Dollar + * `GYD` - Guyanaese Dollar - * `HTG` - Haitian Gourde + * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira + * `HNL` - Honduran Lempira - * `HKD` - Hong Kong Dollar + * `HKD` - Hong Kong Dollar - * `HUF` - Hungarian Forint + * `HUF` - Hungarian Forint - * `IMP` - IMP + * `IMP` - IMP - * `ISK` - Icelandic Króna + * `ISK` - Icelandic Króna - * `ISJ` - Icelandic Króna (1918–1981) + * `ISJ` - Icelandic Króna (1918–1981) - * `INR` - Indian Rupee + * `INR` - Indian Rupee - * `IDR` - Indonesian Rupiah + * `IDR` - Indonesian Rupiah - * `IRR` - Iranian Rial + * `IRR` - Iranian Rial - * `IQD` - Iraqi Dinar + * `IQD` - Iraqi Dinar - * `IEP` - Irish Pound + * `IEP` - Irish Pound - * `ILS` - Israeli New Shekel + * `ILS` - Israeli New Shekel - * `ILP` - Israeli Pound + * `ILP` - Israeli Pound - * `ILR` - Israeli Shekel (1980–1985) + * `ILR` - Israeli Shekel (1980–1985) - * `ITL` - Italian Lira + * `ITL` - Italian Lira - * `JMD` - Jamaican Dollar + * `JMD` - Jamaican Dollar - * `JPY` - Japanese Yen + * `JPY` - Japanese Yen - * `JOD` - Jordanian Dinar + * `JOD` - Jordanian Dinar - * `KZT` - Kazakhstani Tenge + * `KZT` - Kazakhstani Tenge - * `KES` - Kenyan Shilling + * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar + * `KWD` - Kuwaiti Dinar - * `KGS` - Kyrgystani Som + * `KGS` - Kyrgystani Som - * `LAK` - Laotian Kip + * `LAK` - Laotian Kip - * `LVL` - Latvian Lats + * `LVL` - Latvian Lats - * `LVR` - Latvian Ruble + * `LVR` - Latvian Ruble - * `LBP` - Lebanese Pound + * `LBP` - Lebanese Pound - * `LSL` - Lesotho Loti + * `LSL` - Lesotho Loti - * `LRD` - Liberian Dollar + * `LRD` - Liberian Dollar - * `LYD` - Libyan Dinar + * `LYD` - Libyan Dinar - * `LTL` - Lithuanian Litas + * `LTL` - Lithuanian Litas - * `LTT` - Lithuanian Talonas + * `LTT` - Lithuanian Talonas - * `LUL` - Luxembourg Financial Franc + * `LUL` - Luxembourg Financial Franc - * `LUC` - Luxembourgian Convertible Franc + * `LUC` - Luxembourgian Convertible Franc - * `LUF` - Luxembourgian Franc + * `LUF` - Luxembourgian Franc - * `MOP` - Macanese Pataca + * `MOP` - Macanese Pataca - * `MKD` - Macedonian Denar + * `MKD` - Macedonian Denar - * `MKN` - Macedonian Denar (1992–1993) + * `MKN` - Macedonian Denar (1992–1993) - * `MGA` - Malagasy Ariary + * `MGA` - Malagasy Ariary - * `MGF` - Malagasy Franc + * `MGF` - Malagasy Franc - * `MWK` - Malawian Kwacha + * `MWK` - Malawian Kwacha - * `MYR` - Malaysian Ringgit + * `MYR` - Malaysian Ringgit - * `MVR` - Maldivian Rufiyaa + * `MVR` - Maldivian Rufiyaa - * `MVP` - Maldivian Rupee (1947–1981) + * `MVP` - Maldivian Rupee (1947–1981) - * `MLF` - Malian Franc + * `MLF` - Malian Franc - * `MTL` - Maltese Lira + * `MTL` - Maltese Lira - * `MTP` - Maltese Pound + * `MTP` - Maltese Pound - * `MRU` - Mauritanian Ouguiya + * `MRU` - Mauritanian Ouguiya - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MUR` - Mauritian Rupee + * `MUR` - Mauritian Rupee - * `MXV` - Mexican Investment Unit + * `MXV` - Mexican Investment Unit - * `MXN` - Mexican Peso + * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) + * `MXP` - Mexican Silver Peso (1861–1992) - * `MDC` - Moldovan Cupon + * `MDC` - Moldovan Cupon - * `MDL` - Moldovan Leu + * `MDL` - Moldovan Leu - * `MCF` - Monegasque Franc + * `MCF` - Monegasque Franc - * `MNT` - Mongolian Tugrik + * `MNT` - Mongolian Tugrik - * `MAD` - Moroccan Dirham + * `MAD` - Moroccan Dirham - * `MAF` - Moroccan Franc + * `MAF` - Moroccan Franc - * `MZE` - Mozambican Escudo + * `MZE` - Mozambican Escudo - * `MZN` - Mozambican Metical + * `MZN` - Mozambican Metical - * `MZM` - Mozambican Metical (1980–2006) + * `MZM` - Mozambican Metical (1980–2006) - * `MMK` - Myanmar Kyat + * `MMK` - Myanmar Kyat - * `NAD` - Namibian Dollar + * `NAD` - Namibian Dollar - * `NPR` - Nepalese Rupee + * `NPR` - Nepalese Rupee - * `ANG` - Netherlands Antillean Guilder + * `ANG` - Netherlands Antillean Guilder - * `TWD` - New Taiwan Dollar + * `TWD` - New Taiwan Dollar - * `NZD` - New Zealand Dollar + * `NZD` - New Zealand Dollar - * `NIO` - Nicaraguan Córdoba + * `NIO` - Nicaraguan Córdoba - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NGN` - Nigerian Naira + * `NGN` - Nigerian Naira - * `KPW` - North Korean Won + * `KPW` - North Korean Won - * `NOK` - Norwegian Krone + * `NOK` - Norwegian Krone - * `OMR` - Omani Rial + * `OMR` - Omani Rial - * `PKR` - Pakistani Rupee + * `PKR` - Pakistani Rupee - * `XPD` - Palladium + * `XPD` - Palladium - * `PAB` - Panamanian Balboa + * `PAB` - Panamanian Balboa - * `PGK` - Papua New Guinean Kina + * `PGK` - Papua New Guinean Kina - * `PYG` - Paraguayan Guarani + * `PYG` - Paraguayan Guarani - * `PEI` - Peruvian Inti + * `PEI` - Peruvian Inti - * `PEN` - Peruvian Sol + * `PEN` - Peruvian Sol - * `PES` - Peruvian Sol (1863–1965) + * `PES` - Peruvian Sol (1863–1965) - * `PHP` - Philippine Peso + * `PHP` - Philippine Peso - * `XPT` - Platinum + * `XPT` - Platinum - * `PLN` - Polish Zloty + * `PLN` - Polish Zloty - * `PLZ` - Polish Zloty (1950–1995) + * `PLZ` - Polish Zloty (1950–1995) - * `PTE` - Portuguese Escudo + * `PTE` - Portuguese Escudo - * `GWE` - Portuguese Guinea Escudo + * `GWE` - Portuguese Guinea Escudo - * `QAR` - Qatari Rial + * `QAR` - Qatari Rial - * `XRE` - RINET Funds + * `XRE` - RINET Funds - * `RHD` - Rhodesian Dollar + * `RHD` - Rhodesian Dollar - * `RON` - Romanian Leu + * `RON` - Romanian Leu - * `ROL` - Romanian Leu (1952–2006) + * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble + * `RUB` - Russian Ruble - * `RUR` - Russian Ruble (1991–1998) + * `RUR` - Russian Ruble (1991–1998) - * `RWF` - Rwandan Franc + * `RWF` - Rwandan Franc - * `SVC` - Salvadoran Colón + * `SVC` - Salvadoran Colón - * `WST` - Samoan Tala + * `WST` - Samoan Tala - * `SAR` - Saudi Riyal + * `SAR` - Saudi Riyal - * `RSD` - Serbian Dinar + * `RSD` - Serbian Dinar - * `CSD` - Serbian Dinar (2002–2006) + * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee + * `SCR` - Seychellois Rupee - * `SLL` - Sierra Leonean Leone + * `SLL` - Sierra Leonean Leone - * `XAG` - Silver + * `XAG` - Silver - * `SGD` - Singapore Dollar + * `SGD` - Singapore Dollar - * `SKK` - Slovak Koruna + * `SKK` - Slovak Koruna - * `SIT` - Slovenian Tolar + * `SIT` - Slovenian Tolar - * `SBD` - Solomon Islands Dollar + * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling + * `SOS` - Somali Shilling - * `ZAR` - South African Rand + * `ZAR` - South African Rand - * `ZAL` - South African Rand (financial) + * `ZAL` - South African Rand (financial) - * `KRH` - South Korean Hwan (1953–1962) + * `KRH` - South Korean Hwan (1953–1962) - * `KRW` - South Korean Won + * `KRW` - South Korean Won - * `KRO` - South Korean Won (1945–1953) + * `KRO` - South Korean Won (1945–1953) - * `SSP` - South Sudanese Pound + * `SSP` - South Sudanese Pound - * `SUR` - Soviet Rouble + * `SUR` - Soviet Rouble - * `ESP` - Spanish Peseta + * `ESP` - Spanish Peseta - * `ESA` - Spanish Peseta (A account) + * `ESA` - Spanish Peseta (A account) - * `ESB` - Spanish Peseta (convertible account) + * `ESB` - Spanish Peseta (convertible account) - * `XDR` - Special Drawing Rights + * `XDR` - Special Drawing Rights - * `LKR` - Sri Lankan Rupee + * `LKR` - Sri Lankan Rupee - * `SHP` - St. Helena Pound + * `SHP` - St. Helena Pound - * `XSU` - Sucre + * `XSU` - Sucre - * `SDD` - Sudanese Dinar (1992–2007) + * `SDD` - Sudanese Dinar (1992–2007) - * `SDG` - Sudanese Pound + * `SDG` - Sudanese Pound - * `SDP` - Sudanese Pound (1957–1998) + * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar + * `SRD` - Surinamese Dollar - * `SRG` - Surinamese Guilder + * `SRG` - Surinamese Guilder - * `SZL` - Swazi Lilangeni + * `SZL` - Swazi Lilangeni - * `SEK` - Swedish Krona + * `SEK` - Swedish Krona - * `CHF` - Swiss Franc + * `CHF` - Swiss Franc - * `SYP` - Syrian Pound + * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra + * `STN` - São Tomé & Príncipe Dobra - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `TVD` - TVD + * `TVD` - TVD - * `TJR` - Tajikistani Ruble + * `TJR` - Tajikistani Ruble - * `TJS` - Tajikistani Somoni + * `TJS` - Tajikistani Somoni - * `TZS` - Tanzanian Shilling + * `TZS` - Tanzanian Shilling - * `XTS` - Testing Currency Code + * `XTS` - Testing Currency Code - * `THB` - Thai Baht + * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is - involved + * `XXX` - The codes assigned for transactions where no currency is + involved - * `TPE` - Timorese Escudo + * `TPE` - Timorese Escudo - * `TOP` - Tongan Paʻanga + * `TOP` - Tongan Paʻanga - * `TTD` - Trinidad & Tobago Dollar + * `TTD` - Trinidad & Tobago Dollar - * `TND` - Tunisian Dinar + * `TND` - Tunisian Dinar - * `TRY` - Turkish Lira + * `TRY` - Turkish Lira - * `TRL` - Turkish Lira (1922–2005) + * `TRL` - Turkish Lira (1922–2005) - * `TMT` - Turkmenistani Manat + * `TMT` - Turkmenistani Manat - * `TMM` - Turkmenistani Manat (1993–2009) + * `TMM` - Turkmenistani Manat (1993–2009) - * `USD` - US Dollar + * `USD` - US Dollar - * `USN` - US Dollar (Next day) + * `USN` - US Dollar (Next day) - * `USS` - US Dollar (Same day) + * `USS` - US Dollar (Same day) - * `UGX` - Ugandan Shilling + * `UGX` - Ugandan Shilling - * `UGS` - Ugandan Shilling (1966–1987) + * `UGS` - Ugandan Shilling (1966–1987) - * `UAH` - Ukrainian Hryvnia + * `UAH` - Ukrainian Hryvnia - * `UAK` - Ukrainian Karbovanets + * `UAK` - Ukrainian Karbovanets - * `AED` - United Arab Emirates Dirham + * `AED` - United Arab Emirates Dirham - * `UYW` - Uruguayan Nominal Wage Index Unit + * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYU` - Uruguayan Peso + * `UYU` - Uruguayan Peso - * `UYP` - Uruguayan Peso (1975–1993) + * `UYP` - Uruguayan Peso (1975–1993) - * `UYI` - Uruguayan Peso (Indexed Units) + * `UYI` - Uruguayan Peso (Indexed Units) - * `UZS` - Uzbekistani Som + * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu + * `VUV` - Vanuatu Vatu - * `VES` - Venezuelan Bolívar + * `VES` - Venezuelan Bolívar - * `VEB` - Venezuelan Bolívar (1871–2008) + * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEF` - Venezuelan Bolívar (2008–2018) + * `VEF` - Venezuelan Bolívar (2008–2018) - * `VND` - Vietnamese Dong + * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) + * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro + * `CHE` - WIR Euro - * `CHW` - WIR Franc + * `CHW` - WIR Franc - * `XOF` - West African CFA Franc + * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar + * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial + * `YER` - Yemeni Rial - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN + * `ZWN` - ZWN - * `ZRN` - Zairean New Zaire (1993–1998) + * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRZ` - Zairean Zaire (1971–1993) + * `ZRZ` - Zairean Zaire (1971–1993) - * `ZMW` - Zambian Kwacha + * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) + * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWR` - Zimbabwean Dollar (2008) + * `ZWR` - Zimbabwean Dollar (2008) - * `ZWL` - Zimbabwean Dollar (2009) - transaction_currency: - type: optional - docs: >- - The transaction currency that the transaction is made in. + * `ZWL` - Zimbabwean Dollar (2009) + union: + - TransactionCurrencyEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + GeneralLedgerTransactionLineTransactionCurrency: + discriminated: false + docs: >- + The transaction currency that the transaction is made in. - * `XUA` - ADB Unit of Account + * `XUA` - ADB Unit of Account - * `AFN` - Afghan Afghani + * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) + * `AFA` - Afghan Afghani (1927–2002) - * `ALL` - Albanian Lek + * `ALL` - Albanian Lek - * `ALK` - Albanian Lek (1946–1965) + * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar + * `DZD` - Algerian Dinar - * `ADP` - Andorran Peseta + * `ADP` - Andorran Peseta - * `AOA` - Angolan Kwanza + * `AOA` - Angolan Kwanza - * `AOK` - Angolan Kwanza (1977–1991) + * `AOK` - Angolan Kwanza (1977–1991) - * `AON` - Angolan New Kwanza (1990–2000) + * `AON` - Angolan New Kwanza (1990–2000) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `ARA` - Argentine Austral + * `ARA` - Argentine Austral - * `ARS` - Argentine Peso + * `ARS` - Argentine Peso - * `ARM` - Argentine Peso (1881–1970) + * `ARM` - Argentine Peso (1881–1970) - * `ARP` - Argentine Peso (1983–1985) + * `ARP` - Argentine Peso (1983–1985) - * `ARL` - Argentine Peso Ley (1970–1983) + * `ARL` - Argentine Peso Ley (1970–1983) - * `AMD` - Armenian Dram + * `AMD` - Armenian Dram - * `AWG` - Aruban Florin + * `AWG` - Aruban Florin - * `AUD` - Australian Dollar + * `AUD` - Australian Dollar - * `ATS` - Austrian Schilling + * `ATS` - Austrian Schilling - * `AZN` - Azerbaijani Manat + * `AZN` - Azerbaijani Manat - * `AZM` - Azerbaijani Manat (1993–2006) + * `AZM` - Azerbaijani Manat (1993–2006) - * `BSD` - Bahamian Dollar + * `BSD` - Bahamian Dollar - * `BHD` - Bahraini Dinar + * `BHD` - Bahraini Dinar - * `BDT` - Bangladeshi Taka + * `BDT` - Bangladeshi Taka - * `BBD` - Barbadian Dollar + * `BBD` - Barbadian Dollar - * `BYN` - Belarusian Ruble + * `BYN` - Belarusian Ruble - * `BYB` - Belarusian Ruble (1994–1999) + * `BYB` - Belarusian Ruble (1994–1999) - * `BYR` - Belarusian Ruble (2000–2016) + * `BYR` - Belarusian Ruble (2000–2016) - * `BEF` - Belgian Franc + * `BEF` - Belgian Franc - * `BEC` - Belgian Franc (convertible) + * `BEC` - Belgian Franc (convertible) - * `BEL` - Belgian Franc (financial) + * `BEL` - Belgian Franc (financial) - * `BZD` - Belize Dollar + * `BZD` - Belize Dollar - * `BMD` - Bermudan Dollar + * `BMD` - Bermudan Dollar - * `BTN` - Bhutanese Ngultrum + * `BTN` - Bhutanese Ngultrum - * `BOB` - Bolivian Boliviano + * `BOB` - Bolivian Boliviano - * `BOL` - Bolivian Boliviano (1863–1963) + * `BOL` - Bolivian Boliviano (1863–1963) - * `BOV` - Bolivian Mvdol + * `BOV` - Bolivian Mvdol - * `BOP` - Bolivian Peso + * `BOP` - Bolivian Peso - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BWP` - Botswanan Pula + * `BWP` - Botswanan Pula - * `BRC` - Brazilian Cruzado (1986–1989) + * `BRC` - Brazilian Cruzado (1986–1989) - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BRN` - Brazilian New Cruzado (1989–1990) + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BRL` - Brazilian Real + * `BRL` - Brazilian Real - * `GBP` - British Pound + * `GBP` - British Pound - * `BND` - Brunei Dollar + * `BND` - Brunei Dollar - * `BGL` - Bulgarian Hard Lev + * `BGL` - Bulgarian Hard Lev - * `BGN` - Bulgarian Lev + * `BGN` - Bulgarian Lev - * `BGO` - Bulgarian Lev (1879–1952) + * `BGO` - Bulgarian Lev (1879–1952) - * `BGM` - Bulgarian Socialist Lev + * `BGM` - Bulgarian Socialist Lev - * `BUK` - Burmese Kyat + * `BUK` - Burmese Kyat - * `BIF` - Burundian Franc + * `BIF` - Burundian Franc - * `XPF` - CFP Franc + * `XPF` - CFP Franc - * `KHR` - Cambodian Riel + * `KHR` - Cambodian Riel - * `CAD` - Canadian Dollar + * `CAD` - Canadian Dollar - * `CVE` - Cape Verdean Escudo + * `CVE` - Cape Verdean Escudo - * `KYD` - Cayman Islands Dollar + * `KYD` - Cayman Islands Dollar - * `XAF` - Central African CFA Franc + * `XAF` - Central African CFA Franc - * `CLE` - Chilean Escudo + * `CLE` - Chilean Escudo - * `CLP` - Chilean Peso + * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) + * `CLF` - Chilean Unit of Account (UF) - * `CNX` - Chinese People’s Bank Dollar + * `CNX` - Chinese People’s Bank Dollar - * `CNY` - Chinese Yuan + * `CNY` - Chinese Yuan - * `CNH` - Chinese Yuan (offshore) + * `CNH` - Chinese Yuan (offshore) - * `COP` - Colombian Peso + * `COP` - Colombian Peso - * `COU` - Colombian Real Value Unit + * `COU` - Colombian Real Value Unit - * `KMF` - Comorian Franc + * `KMF` - Comorian Franc - * `CDF` - Congolese Franc + * `CDF` - Congolese Franc - * `CRC` - Costa Rican Colón + * `CRC` - Costa Rican Colón - * `HRD` - Croatian Dinar + * `HRD` - Croatian Dinar - * `HRK` - Croatian Kuna + * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso + * `CUC` - Cuban Convertible Peso - * `CUP` - Cuban Peso + * `CUP` - Cuban Peso - * `CYP` - Cypriot Pound + * `CYP` - Cypriot Pound - * `CZK` - Czech Koruna + * `CZK` - Czech Koruna - * `CSK` - Czechoslovak Hard Koruna + * `CSK` - Czechoslovak Hard Koruna - * `DKK` - Danish Krone + * `DKK` - Danish Krone - * `DJF` - Djiboutian Franc + * `DJF` - Djiboutian Franc - * `DOP` - Dominican Peso + * `DOP` - Dominican Peso - * `NLG` - Dutch Guilder + * `NLG` - Dutch Guilder - * `XCD` - East Caribbean Dollar + * `XCD` - East Caribbean Dollar - * `DDM` - East German Mark + * `DDM` - East German Mark - * `ECS` - Ecuadorian Sucre + * `ECS` - Ecuadorian Sucre - * `ECV` - Ecuadorian Unit of Constant Value + * `ECV` - Ecuadorian Unit of Constant Value - * `EGP` - Egyptian Pound + * `EGP` - Egyptian Pound - * `GQE` - Equatorial Guinean Ekwele + * `GQE` - Equatorial Guinean Ekwele - * `ERN` - Eritrean Nakfa + * `ERN` - Eritrean Nakfa - * `EEK` - Estonian Kroon + * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr + * `ETB` - Ethiopian Birr - * `EUR` - Euro + * `EUR` - Euro - * `XBA` - European Composite Unit + * `XBA` - European Composite Unit - * `XEU` - European Currency Unit + * `XEU` - European Currency Unit - * `XBB` - European Monetary Unit + * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) + * `XBC` - European Unit of Account (XBC) - * `XBD` - European Unit of Account (XBD) + * `XBD` - European Unit of Account (XBD) - * `FKP` - Falkland Islands Pound + * `FKP` - Falkland Islands Pound - * `FJD` - Fijian Dollar + * `FJD` - Fijian Dollar - * `FIM` - Finnish Markka + * `FIM` - Finnish Markka - * `FRF` - French Franc + * `FRF` - French Franc - * `XFO` - French Gold Franc + * `XFO` - French Gold Franc - * `XFU` - French UIC-Franc + * `XFU` - French UIC-Franc - * `GMD` - Gambian Dalasi + * `GMD` - Gambian Dalasi - * `GEK` - Georgian Kupon Larit + * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari + * `GEL` - Georgian Lari - * `DEM` - German Mark + * `DEM` - German Mark - * `GHS` - Ghanaian Cedi + * `GHS` - Ghanaian Cedi - * `GHC` - Ghanaian Cedi (1979–2007) + * `GHC` - Ghanaian Cedi (1979–2007) - * `GIP` - Gibraltar Pound + * `GIP` - Gibraltar Pound - * `XAU` - Gold + * `XAU` - Gold - * `GRD` - Greek Drachma + * `GRD` - Greek Drachma - * `GTQ` - Guatemalan Quetzal + * `GTQ` - Guatemalan Quetzal - * `GWP` - Guinea-Bissau Peso + * `GWP` - Guinea-Bissau Peso - * `GNF` - Guinean Franc + * `GNF` - Guinean Franc - * `GNS` - Guinean Syli + * `GNS` - Guinean Syli - * `GYD` - Guyanaese Dollar + * `GYD` - Guyanaese Dollar - * `HTG` - Haitian Gourde + * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira + * `HNL` - Honduran Lempira - * `HKD` - Hong Kong Dollar + * `HKD` - Hong Kong Dollar - * `HUF` - Hungarian Forint + * `HUF` - Hungarian Forint - * `IMP` - IMP + * `IMP` - IMP - * `ISK` - Icelandic Króna + * `ISK` - Icelandic Króna - * `ISJ` - Icelandic Króna (1918–1981) + * `ISJ` - Icelandic Króna (1918–1981) - * `INR` - Indian Rupee + * `INR` - Indian Rupee - * `IDR` - Indonesian Rupiah + * `IDR` - Indonesian Rupiah - * `IRR` - Iranian Rial + * `IRR` - Iranian Rial - * `IQD` - Iraqi Dinar + * `IQD` - Iraqi Dinar - * `IEP` - Irish Pound + * `IEP` - Irish Pound - * `ILS` - Israeli New Shekel + * `ILS` - Israeli New Shekel - * `ILP` - Israeli Pound + * `ILP` - Israeli Pound - * `ILR` - Israeli Shekel (1980–1985) + * `ILR` - Israeli Shekel (1980–1985) - * `ITL` - Italian Lira + * `ITL` - Italian Lira - * `JMD` - Jamaican Dollar + * `JMD` - Jamaican Dollar - * `JPY` - Japanese Yen + * `JPY` - Japanese Yen - * `JOD` - Jordanian Dinar + * `JOD` - Jordanian Dinar - * `KZT` - Kazakhstani Tenge + * `KZT` - Kazakhstani Tenge - * `KES` - Kenyan Shilling + * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar + * `KWD` - Kuwaiti Dinar - * `KGS` - Kyrgystani Som + * `KGS` - Kyrgystani Som - * `LAK` - Laotian Kip + * `LAK` - Laotian Kip - * `LVL` - Latvian Lats + * `LVL` - Latvian Lats - * `LVR` - Latvian Ruble + * `LVR` - Latvian Ruble - * `LBP` - Lebanese Pound + * `LBP` - Lebanese Pound - * `LSL` - Lesotho Loti + * `LSL` - Lesotho Loti - * `LRD` - Liberian Dollar + * `LRD` - Liberian Dollar - * `LYD` - Libyan Dinar + * `LYD` - Libyan Dinar - * `LTL` - Lithuanian Litas + * `LTL` - Lithuanian Litas - * `LTT` - Lithuanian Talonas + * `LTT` - Lithuanian Talonas - * `LUL` - Luxembourg Financial Franc + * `LUL` - Luxembourg Financial Franc - * `LUC` - Luxembourgian Convertible Franc + * `LUC` - Luxembourgian Convertible Franc - * `LUF` - Luxembourgian Franc + * `LUF` - Luxembourgian Franc - * `MOP` - Macanese Pataca + * `MOP` - Macanese Pataca - * `MKD` - Macedonian Denar + * `MKD` - Macedonian Denar - * `MKN` - Macedonian Denar (1992–1993) + * `MKN` - Macedonian Denar (1992–1993) - * `MGA` - Malagasy Ariary + * `MGA` - Malagasy Ariary - * `MGF` - Malagasy Franc + * `MGF` - Malagasy Franc - * `MWK` - Malawian Kwacha + * `MWK` - Malawian Kwacha - * `MYR` - Malaysian Ringgit + * `MYR` - Malaysian Ringgit - * `MVR` - Maldivian Rufiyaa + * `MVR` - Maldivian Rufiyaa - * `MVP` - Maldivian Rupee (1947–1981) + * `MVP` - Maldivian Rupee (1947–1981) - * `MLF` - Malian Franc + * `MLF` - Malian Franc - * `MTL` - Maltese Lira + * `MTL` - Maltese Lira - * `MTP` - Maltese Pound + * `MTP` - Maltese Pound - * `MRU` - Mauritanian Ouguiya + * `MRU` - Mauritanian Ouguiya - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MUR` - Mauritian Rupee + * `MUR` - Mauritian Rupee - * `MXV` - Mexican Investment Unit + * `MXV` - Mexican Investment Unit - * `MXN` - Mexican Peso + * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) + * `MXP` - Mexican Silver Peso (1861–1992) - * `MDC` - Moldovan Cupon + * `MDC` - Moldovan Cupon - * `MDL` - Moldovan Leu + * `MDL` - Moldovan Leu - * `MCF` - Monegasque Franc + * `MCF` - Monegasque Franc - * `MNT` - Mongolian Tugrik + * `MNT` - Mongolian Tugrik - * `MAD` - Moroccan Dirham + * `MAD` - Moroccan Dirham - * `MAF` - Moroccan Franc + * `MAF` - Moroccan Franc - * `MZE` - Mozambican Escudo + * `MZE` - Mozambican Escudo - * `MZN` - Mozambican Metical + * `MZN` - Mozambican Metical - * `MZM` - Mozambican Metical (1980–2006) + * `MZM` - Mozambican Metical (1980–2006) - * `MMK` - Myanmar Kyat + * `MMK` - Myanmar Kyat - * `NAD` - Namibian Dollar + * `NAD` - Namibian Dollar - * `NPR` - Nepalese Rupee + * `NPR` - Nepalese Rupee - * `ANG` - Netherlands Antillean Guilder + * `ANG` - Netherlands Antillean Guilder - * `TWD` - New Taiwan Dollar + * `TWD` - New Taiwan Dollar - * `NZD` - New Zealand Dollar + * `NZD` - New Zealand Dollar - * `NIO` - Nicaraguan Córdoba + * `NIO` - Nicaraguan Córdoba - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NGN` - Nigerian Naira + * `NGN` - Nigerian Naira - * `KPW` - North Korean Won + * `KPW` - North Korean Won - * `NOK` - Norwegian Krone + * `NOK` - Norwegian Krone - * `OMR` - Omani Rial + * `OMR` - Omani Rial - * `PKR` - Pakistani Rupee + * `PKR` - Pakistani Rupee - * `XPD` - Palladium + * `XPD` - Palladium - * `PAB` - Panamanian Balboa + * `PAB` - Panamanian Balboa - * `PGK` - Papua New Guinean Kina + * `PGK` - Papua New Guinean Kina - * `PYG` - Paraguayan Guarani + * `PYG` - Paraguayan Guarani - * `PEI` - Peruvian Inti + * `PEI` - Peruvian Inti - * `PEN` - Peruvian Sol + * `PEN` - Peruvian Sol - * `PES` - Peruvian Sol (1863–1965) + * `PES` - Peruvian Sol (1863–1965) - * `PHP` - Philippine Peso + * `PHP` - Philippine Peso - * `XPT` - Platinum + * `XPT` - Platinum - * `PLN` - Polish Zloty + * `PLN` - Polish Zloty - * `PLZ` - Polish Zloty (1950–1995) + * `PLZ` - Polish Zloty (1950–1995) - * `PTE` - Portuguese Escudo + * `PTE` - Portuguese Escudo - * `GWE` - Portuguese Guinea Escudo + * `GWE` - Portuguese Guinea Escudo - * `QAR` - Qatari Rial + * `QAR` - Qatari Rial - * `XRE` - RINET Funds + * `XRE` - RINET Funds - * `RHD` - Rhodesian Dollar + * `RHD` - Rhodesian Dollar - * `RON` - Romanian Leu + * `RON` - Romanian Leu - * `ROL` - Romanian Leu (1952–2006) + * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble + * `RUB` - Russian Ruble - * `RUR` - Russian Ruble (1991–1998) + * `RUR` - Russian Ruble (1991–1998) - * `RWF` - Rwandan Franc + * `RWF` - Rwandan Franc - * `SVC` - Salvadoran Colón + * `SVC` - Salvadoran Colón - * `WST` - Samoan Tala + * `WST` - Samoan Tala - * `SAR` - Saudi Riyal + * `SAR` - Saudi Riyal - * `RSD` - Serbian Dinar + * `RSD` - Serbian Dinar - * `CSD` - Serbian Dinar (2002–2006) + * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee + * `SCR` - Seychellois Rupee - * `SLL` - Sierra Leonean Leone + * `SLL` - Sierra Leonean Leone - * `XAG` - Silver + * `XAG` - Silver - * `SGD` - Singapore Dollar + * `SGD` - Singapore Dollar - * `SKK` - Slovak Koruna + * `SKK` - Slovak Koruna - * `SIT` - Slovenian Tolar + * `SIT` - Slovenian Tolar - * `SBD` - Solomon Islands Dollar + * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling + * `SOS` - Somali Shilling - * `ZAR` - South African Rand + * `ZAR` - South African Rand - * `ZAL` - South African Rand (financial) + * `ZAL` - South African Rand (financial) - * `KRH` - South Korean Hwan (1953–1962) + * `KRH` - South Korean Hwan (1953–1962) - * `KRW` - South Korean Won + * `KRW` - South Korean Won - * `KRO` - South Korean Won (1945–1953) + * `KRO` - South Korean Won (1945–1953) - * `SSP` - South Sudanese Pound + * `SSP` - South Sudanese Pound - * `SUR` - Soviet Rouble + * `SUR` - Soviet Rouble - * `ESP` - Spanish Peseta + * `ESP` - Spanish Peseta - * `ESA` - Spanish Peseta (A account) + * `ESA` - Spanish Peseta (A account) - * `ESB` - Spanish Peseta (convertible account) + * `ESB` - Spanish Peseta (convertible account) - * `XDR` - Special Drawing Rights + * `XDR` - Special Drawing Rights - * `LKR` - Sri Lankan Rupee + * `LKR` - Sri Lankan Rupee - * `SHP` - St. Helena Pound + * `SHP` - St. Helena Pound - * `XSU` - Sucre + * `XSU` - Sucre - * `SDD` - Sudanese Dinar (1992–2007) + * `SDD` - Sudanese Dinar (1992–2007) - * `SDG` - Sudanese Pound + * `SDG` - Sudanese Pound - * `SDP` - Sudanese Pound (1957–1998) + * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar + * `SRD` - Surinamese Dollar - * `SRG` - Surinamese Guilder + * `SRG` - Surinamese Guilder - * `SZL` - Swazi Lilangeni + * `SZL` - Swazi Lilangeni - * `SEK` - Swedish Krona + * `SEK` - Swedish Krona - * `CHF` - Swiss Franc + * `CHF` - Swiss Franc - * `SYP` - Syrian Pound + * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra + * `STN` - São Tomé & Príncipe Dobra - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `TVD` - TVD + * `TVD` - TVD - * `TJR` - Tajikistani Ruble + * `TJR` - Tajikistani Ruble - * `TJS` - Tajikistani Somoni + * `TJS` - Tajikistani Somoni - * `TZS` - Tanzanian Shilling + * `TZS` - Tanzanian Shilling - * `XTS` - Testing Currency Code + * `XTS` - Testing Currency Code - * `THB` - Thai Baht + * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is - involved + * `XXX` - The codes assigned for transactions where no currency is + involved - * `TPE` - Timorese Escudo + * `TPE` - Timorese Escudo - * `TOP` - Tongan Paʻanga + * `TOP` - Tongan Paʻanga - * `TTD` - Trinidad & Tobago Dollar + * `TTD` - Trinidad & Tobago Dollar - * `TND` - Tunisian Dinar + * `TND` - Tunisian Dinar - * `TRY` - Turkish Lira + * `TRY` - Turkish Lira - * `TRL` - Turkish Lira (1922–2005) + * `TRL` - Turkish Lira (1922–2005) - * `TMT` - Turkmenistani Manat + * `TMT` - Turkmenistani Manat - * `TMM` - Turkmenistani Manat (1993–2009) + * `TMM` - Turkmenistani Manat (1993–2009) - * `USD` - US Dollar + * `USD` - US Dollar - * `USN` - US Dollar (Next day) + * `USN` - US Dollar (Next day) - * `USS` - US Dollar (Same day) + * `USS` - US Dollar (Same day) - * `UGX` - Ugandan Shilling + * `UGX` - Ugandan Shilling - * `UGS` - Ugandan Shilling (1966–1987) + * `UGS` - Ugandan Shilling (1966–1987) - * `UAH` - Ukrainian Hryvnia + * `UAH` - Ukrainian Hryvnia - * `UAK` - Ukrainian Karbovanets + * `UAK` - Ukrainian Karbovanets - * `AED` - United Arab Emirates Dirham + * `AED` - United Arab Emirates Dirham - * `UYW` - Uruguayan Nominal Wage Index Unit + * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYU` - Uruguayan Peso + * `UYU` - Uruguayan Peso - * `UYP` - Uruguayan Peso (1975–1993) + * `UYP` - Uruguayan Peso (1975–1993) - * `UYI` - Uruguayan Peso (Indexed Units) + * `UYI` - Uruguayan Peso (Indexed Units) - * `UZS` - Uzbekistani Som + * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu + * `VUV` - Vanuatu Vatu - * `VES` - Venezuelan Bolívar + * `VES` - Venezuelan Bolívar - * `VEB` - Venezuelan Bolívar (1871–2008) + * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEF` - Venezuelan Bolívar (2008–2018) + * `VEF` - Venezuelan Bolívar (2008–2018) - * `VND` - Vietnamese Dong + * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) + * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro + * `CHE` - WIR Euro - * `CHW` - WIR Franc + * `CHW` - WIR Franc - * `XOF` - West African CFA Franc + * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar + * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial + * `YER` - Yemeni Rial - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN + * `ZWN` - ZWN - * `ZRN` - Zairean New Zaire (1993–1998) + * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRZ` - Zairean Zaire (1971–1993) + * `ZRZ` - Zairean Zaire (1971–1993) - * `ZMW` - Zambian Kwacha + * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) + * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWR` - Zimbabwean Dollar (2008) + * `ZWR` - Zimbabwean Dollar (2008) - * `ZWL` - Zimbabwean Dollar (2009) - exchange_rate: - type: optional - docs: >- - The exchange rate between the base currency and the transaction - currency. + * `ZWL` - Zimbabwean Dollar (2009) + union: + - TransactionCurrencyEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + GeneralLedgerTransactionLineTrackingCategoriesItem: + discriminated: false + union: + - type: string validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - description: - type: optional - docs: A description of the line item. - tracking_categories: - type: optional> - access: read-only - debit_amount: string - credit_amount: string - item: optional - foreign_debit_amount: string - foreign_credit_amount: string - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - field_mappings: - type: optional> - access: read-only + format: uuid + - TrackingCategory source: openapi: openapi/openapi.yml - IncomeStatementCurrency: + inline: true + GeneralLedgerTransactionLineItem: discriminated: false + union: + - type: string + validation: + format: uuid + - Item + source: + openapi: openapi/openapi.yml + inline: true + GeneralLedgerTransactionLine: docs: >- - The income statement's currency. + # The GeneralLedgerTransactionLineSerializer Object + ### Description - * `XUA` - ADB Unit of Account + The `GeneralLedgerTransactionLineSerializer` object represents general + ledger transaction line item. - * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) + ### Usage Example Fetch from the `GET + GeneralLedgerTransactionLineSerializer` endpoint and view an - * `ALL` - Albanian Lek + `GeneralLedgerTransaction` line item. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + account: optional + company: + type: optional + docs: The company the GeneralLedgerTransaction belongs to. + employee: optional + contact: optional + project: optional + base_currency: + type: optional + docs: >- + The base currency of the transaction - * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar + * `XUA` - ADB Unit of Account - * `ADP` - Andorran Peseta + * `AFN` - Afghan Afghani - * `AOA` - Angolan Kwanza + * `AFA` - Afghan Afghani (1927–2002) - * `AOK` - Angolan Kwanza (1977–1991) + * `ALL` - Albanian Lek - * `AON` - Angolan New Kwanza (1990–2000) + * `ALK` - Albanian Lek (1946–1965) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) + * `DZD` - Algerian Dinar - * `ARA` - Argentine Austral + * `ADP` - Andorran Peseta - * `ARS` - Argentine Peso + * `AOA` - Angolan Kwanza - * `ARM` - Argentine Peso (1881–1970) + * `AOK` - Angolan Kwanza (1977–1991) - * `ARP` - Argentine Peso (1983–1985) + * `AON` - Angolan New Kwanza (1990–2000) - * `ARL` - Argentine Peso Ley (1970–1983) + * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `AMD` - Armenian Dram + * `ARA` - Argentine Austral - * `AWG` - Aruban Florin + * `ARS` - Argentine Peso - * `AUD` - Australian Dollar + * `ARM` - Argentine Peso (1881–1970) - * `ATS` - Austrian Schilling + * `ARP` - Argentine Peso (1983–1985) - * `AZN` - Azerbaijani Manat + * `ARL` - Argentine Peso Ley (1970–1983) - * `AZM` - Azerbaijani Manat (1993–2006) + * `AMD` - Armenian Dram - * `BSD` - Bahamian Dollar + * `AWG` - Aruban Florin - * `BHD` - Bahraini Dinar + * `AUD` - Australian Dollar - * `BDT` - Bangladeshi Taka + * `ATS` - Austrian Schilling - * `BBD` - Barbadian Dollar + * `AZN` - Azerbaijani Manat - * `BYN` - Belarusian Ruble + * `AZM` - Azerbaijani Manat (1993–2006) - * `BYB` - Belarusian Ruble (1994–1999) + * `BSD` - Bahamian Dollar - * `BYR` - Belarusian Ruble (2000–2016) + * `BHD` - Bahraini Dinar - * `BEF` - Belgian Franc + * `BDT` - Bangladeshi Taka - * `BEC` - Belgian Franc (convertible) + * `BBD` - Barbadian Dollar - * `BEL` - Belgian Franc (financial) + * `BYN` - Belarusian Ruble - * `BZD` - Belize Dollar + * `BYB` - Belarusian Ruble (1994–1999) - * `BMD` - Bermudan Dollar + * `BYR` - Belarusian Ruble (2000–2016) - * `BTN` - Bhutanese Ngultrum + * `BEF` - Belgian Franc - * `BOB` - Bolivian Boliviano + * `BEC` - Belgian Franc (convertible) - * `BOL` - Bolivian Boliviano (1863–1963) + * `BEL` - Belgian Franc (financial) - * `BOV` - Bolivian Mvdol + * `BZD` - Belize Dollar - * `BOP` - Bolivian Peso + * `BMD` - Bermudan Dollar - * `BAM` - Bosnia-Herzegovina Convertible Mark + * `BTN` - Bhutanese Ngultrum - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) + * `BOB` - Bolivian Boliviano - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) + * `BOL` - Bolivian Boliviano (1863–1963) - * `BWP` - Botswanan Pula + * `BOV` - Bolivian Mvdol - * `BRC` - Brazilian Cruzado (1986–1989) + * `BOP` - Bolivian Peso - * `BRZ` - Brazilian Cruzeiro (1942–1967) + * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BRE` - Brazilian Cruzeiro (1990–1993) + * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BRR` - Brazilian Cruzeiro (1993–1994) + * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BRN` - Brazilian New Cruzado (1989–1990) + * `BWP` - Botswanan Pula - * `BRB` - Brazilian New Cruzeiro (1967–1986) + * `BRC` - Brazilian Cruzado (1986–1989) - * `BRL` - Brazilian Real + * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `GBP` - British Pound + * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BND` - Brunei Dollar + * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BGL` - Bulgarian Hard Lev + * `BRN` - Brazilian New Cruzado (1989–1990) - * `BGN` - Bulgarian Lev + * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BGO` - Bulgarian Lev (1879–1952) + * `BRL` - Brazilian Real - * `BGM` - Bulgarian Socialist Lev + * `GBP` - British Pound - * `BUK` - Burmese Kyat + * `BND` - Brunei Dollar - * `BIF` - Burundian Franc + * `BGL` - Bulgarian Hard Lev - * `XPF` - CFP Franc + * `BGN` - Bulgarian Lev - * `KHR` - Cambodian Riel + * `BGO` - Bulgarian Lev (1879–1952) - * `CAD` - Canadian Dollar + * `BGM` - Bulgarian Socialist Lev - * `CVE` - Cape Verdean Escudo + * `BUK` - Burmese Kyat - * `KYD` - Cayman Islands Dollar + * `BIF` - Burundian Franc - * `XAF` - Central African CFA Franc + * `XPF` - CFP Franc - * `CLE` - Chilean Escudo + * `KHR` - Cambodian Riel - * `CLP` - Chilean Peso + * `CAD` - Canadian Dollar - * `CLF` - Chilean Unit of Account (UF) + * `CVE` - Cape Verdean Escudo - * `CNX` - Chinese People’s Bank Dollar + * `KYD` - Cayman Islands Dollar - * `CNY` - Chinese Yuan + * `XAF` - Central African CFA Franc - * `CNH` - Chinese Yuan (offshore) + * `CLE` - Chilean Escudo - * `COP` - Colombian Peso + * `CLP` - Chilean Peso - * `COU` - Colombian Real Value Unit + * `CLF` - Chilean Unit of Account (UF) - * `KMF` - Comorian Franc + * `CNX` - Chinese People’s Bank Dollar - * `CDF` - Congolese Franc + * `CNY` - Chinese Yuan - * `CRC` - Costa Rican Colón + * `CNH` - Chinese Yuan (offshore) - * `HRD` - Croatian Dinar + * `COP` - Colombian Peso - * `HRK` - Croatian Kuna + * `COU` - Colombian Real Value Unit - * `CUC` - Cuban Convertible Peso + * `KMF` - Comorian Franc - * `CUP` - Cuban Peso + * `CDF` - Congolese Franc - * `CYP` - Cypriot Pound + * `CRC` - Costa Rican Colón - * `CZK` - Czech Koruna + * `HRD` - Croatian Dinar - * `CSK` - Czechoslovak Hard Koruna + * `HRK` - Croatian Kuna - * `DKK` - Danish Krone + * `CUC` - Cuban Convertible Peso - * `DJF` - Djiboutian Franc + * `CUP` - Cuban Peso - * `DOP` - Dominican Peso + * `CYP` - Cypriot Pound - * `NLG` - Dutch Guilder + * `CZK` - Czech Koruna - * `XCD` - East Caribbean Dollar + * `CSK` - Czechoslovak Hard Koruna - * `DDM` - East German Mark + * `DKK` - Danish Krone - * `ECS` - Ecuadorian Sucre + * `DJF` - Djiboutian Franc - * `ECV` - Ecuadorian Unit of Constant Value + * `DOP` - Dominican Peso - * `EGP` - Egyptian Pound + * `NLG` - Dutch Guilder - * `GQE` - Equatorial Guinean Ekwele + * `XCD` - East Caribbean Dollar - * `ERN` - Eritrean Nakfa + * `DDM` - East German Mark - * `EEK` - Estonian Kroon + * `ECS` - Ecuadorian Sucre - * `ETB` - Ethiopian Birr + * `ECV` - Ecuadorian Unit of Constant Value - * `EUR` - Euro + * `EGP` - Egyptian Pound - * `XBA` - European Composite Unit + * `GQE` - Equatorial Guinean Ekwele - * `XEU` - European Currency Unit + * `ERN` - Eritrean Nakfa - * `XBB` - European Monetary Unit + * `EEK` - Estonian Kroon - * `XBC` - European Unit of Account (XBC) + * `ETB` - Ethiopian Birr - * `XBD` - European Unit of Account (XBD) + * `EUR` - Euro - * `FKP` - Falkland Islands Pound + * `XBA` - European Composite Unit - * `FJD` - Fijian Dollar + * `XEU` - European Currency Unit - * `FIM` - Finnish Markka + * `XBB` - European Monetary Unit - * `FRF` - French Franc + * `XBC` - European Unit of Account (XBC) - * `XFO` - French Gold Franc + * `XBD` - European Unit of Account (XBD) - * `XFU` - French UIC-Franc + * `FKP` - Falkland Islands Pound - * `GMD` - Gambian Dalasi + * `FJD` - Fijian Dollar - * `GEK` - Georgian Kupon Larit + * `FIM` - Finnish Markka - * `GEL` - Georgian Lari + * `FRF` - French Franc - * `DEM` - German Mark + * `XFO` - French Gold Franc - * `GHS` - Ghanaian Cedi + * `XFU` - French UIC-Franc - * `GHC` - Ghanaian Cedi (1979–2007) + * `GMD` - Gambian Dalasi - * `GIP` - Gibraltar Pound + * `GEK` - Georgian Kupon Larit - * `XAU` - Gold + * `GEL` - Georgian Lari - * `GRD` - Greek Drachma + * `DEM` - German Mark - * `GTQ` - Guatemalan Quetzal + * `GHS` - Ghanaian Cedi - * `GWP` - Guinea-Bissau Peso + * `GHC` - Ghanaian Cedi (1979–2007) - * `GNF` - Guinean Franc + * `GIP` - Gibraltar Pound - * `GNS` - Guinean Syli + * `XAU` - Gold - * `GYD` - Guyanaese Dollar + * `GRD` - Greek Drachma - * `HTG` - Haitian Gourde + * `GTQ` - Guatemalan Quetzal - * `HNL` - Honduran Lempira + * `GWP` - Guinea-Bissau Peso - * `HKD` - Hong Kong Dollar + * `GNF` - Guinean Franc - * `HUF` - Hungarian Forint + * `GNS` - Guinean Syli - * `IMP` - IMP + * `GYD` - Guyanaese Dollar - * `ISK` - Icelandic Króna + * `HTG` - Haitian Gourde - * `ISJ` - Icelandic Króna (1918–1981) + * `HNL` - Honduran Lempira - * `INR` - Indian Rupee + * `HKD` - Hong Kong Dollar - * `IDR` - Indonesian Rupiah + * `HUF` - Hungarian Forint - * `IRR` - Iranian Rial + * `IMP` - IMP - * `IQD` - Iraqi Dinar + * `ISK` - Icelandic Króna - * `IEP` - Irish Pound + * `ISJ` - Icelandic Króna (1918–1981) - * `ILS` - Israeli New Shekel + * `INR` - Indian Rupee - * `ILP` - Israeli Pound + * `IDR` - Indonesian Rupiah - * `ILR` - Israeli Shekel (1980–1985) + * `IRR` - Iranian Rial - * `ITL` - Italian Lira + * `IQD` - Iraqi Dinar - * `JMD` - Jamaican Dollar + * `IEP` - Irish Pound - * `JPY` - Japanese Yen + * `ILS` - Israeli New Shekel - * `JOD` - Jordanian Dinar + * `ILP` - Israeli Pound - * `KZT` - Kazakhstani Tenge + * `ILR` - Israeli Shekel (1980–1985) - * `KES` - Kenyan Shilling + * `ITL` - Italian Lira - * `KWD` - Kuwaiti Dinar + * `JMD` - Jamaican Dollar - * `KGS` - Kyrgystani Som + * `JPY` - Japanese Yen - * `LAK` - Laotian Kip + * `JOD` - Jordanian Dinar - * `LVL` - Latvian Lats + * `KZT` - Kazakhstani Tenge - * `LVR` - Latvian Ruble + * `KES` - Kenyan Shilling - * `LBP` - Lebanese Pound + * `KWD` - Kuwaiti Dinar - * `LSL` - Lesotho Loti + * `KGS` - Kyrgystani Som - * `LRD` - Liberian Dollar + * `LAK` - Laotian Kip - * `LYD` - Libyan Dinar + * `LVL` - Latvian Lats - * `LTL` - Lithuanian Litas + * `LVR` - Latvian Ruble - * `LTT` - Lithuanian Talonas + * `LBP` - Lebanese Pound - * `LUL` - Luxembourg Financial Franc + * `LSL` - Lesotho Loti - * `LUC` - Luxembourgian Convertible Franc + * `LRD` - Liberian Dollar - * `LUF` - Luxembourgian Franc + * `LYD` - Libyan Dinar - * `MOP` - Macanese Pataca + * `LTL` - Lithuanian Litas - * `MKD` - Macedonian Denar + * `LTT` - Lithuanian Talonas - * `MKN` - Macedonian Denar (1992–1993) + * `LUL` - Luxembourg Financial Franc - * `MGA` - Malagasy Ariary + * `LUC` - Luxembourgian Convertible Franc - * `MGF` - Malagasy Franc + * `LUF` - Luxembourgian Franc - * `MWK` - Malawian Kwacha + * `MOP` - Macanese Pataca - * `MYR` - Malaysian Ringgit + * `MKD` - Macedonian Denar - * `MVR` - Maldivian Rufiyaa + * `MKN` - Macedonian Denar (1992–1993) - * `MVP` - Maldivian Rupee (1947–1981) + * `MGA` - Malagasy Ariary - * `MLF` - Malian Franc + * `MGF` - Malagasy Franc - * `MTL` - Maltese Lira + * `MWK` - Malawian Kwacha - * `MTP` - Maltese Pound + * `MYR` - Malaysian Ringgit - * `MRU` - Mauritanian Ouguiya + * `MVR` - Maldivian Rufiyaa - * `MRO` - Mauritanian Ouguiya (1973–2017) + * `MVP` - Maldivian Rupee (1947–1981) - * `MUR` - Mauritian Rupee + * `MLF` - Malian Franc - * `MXV` - Mexican Investment Unit + * `MTL` - Maltese Lira - * `MXN` - Mexican Peso + * `MTP` - Maltese Pound - * `MXP` - Mexican Silver Peso (1861–1992) + * `MRU` - Mauritanian Ouguiya - * `MDC` - Moldovan Cupon + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MDL` - Moldovan Leu + * `MUR` - Mauritian Rupee - * `MCF` - Monegasque Franc + * `MXV` - Mexican Investment Unit - * `MNT` - Mongolian Tugrik + * `MXN` - Mexican Peso - * `MAD` - Moroccan Dirham + * `MXP` - Mexican Silver Peso (1861–1992) - * `MAF` - Moroccan Franc + * `MDC` - Moldovan Cupon - * `MZE` - Mozambican Escudo + * `MDL` - Moldovan Leu - * `MZN` - Mozambican Metical + * `MCF` - Monegasque Franc - * `MZM` - Mozambican Metical (1980–2006) + * `MNT` - Mongolian Tugrik - * `MMK` - Myanmar Kyat + * `MAD` - Moroccan Dirham - * `NAD` - Namibian Dollar + * `MAF` - Moroccan Franc - * `NPR` - Nepalese Rupee + * `MZE` - Mozambican Escudo - * `ANG` - Netherlands Antillean Guilder + * `MZN` - Mozambican Metical - * `TWD` - New Taiwan Dollar + * `MZM` - Mozambican Metical (1980–2006) - * `NZD` - New Zealand Dollar + * `MMK` - Myanmar Kyat - * `NIO` - Nicaraguan Córdoba + * `NAD` - Namibian Dollar - * `NIC` - Nicaraguan Córdoba (1988–1991) + * `NPR` - Nepalese Rupee - * `NGN` - Nigerian Naira + * `ANG` - Netherlands Antillean Guilder - * `KPW` - North Korean Won + * `TWD` - New Taiwan Dollar - * `NOK` - Norwegian Krone + * `NZD` - New Zealand Dollar - * `OMR` - Omani Rial + * `NIO` - Nicaraguan Córdoba - * `PKR` - Pakistani Rupee + * `NIC` - Nicaraguan Córdoba (1988–1991) - * `XPD` - Palladium + * `NGN` - Nigerian Naira - * `PAB` - Panamanian Balboa + * `KPW` - North Korean Won - * `PGK` - Papua New Guinean Kina + * `NOK` - Norwegian Krone - * `PYG` - Paraguayan Guarani + * `OMR` - Omani Rial - * `PEI` - Peruvian Inti + * `PKR` - Pakistani Rupee - * `PEN` - Peruvian Sol + * `XPD` - Palladium - * `PES` - Peruvian Sol (1863–1965) + * `PAB` - Panamanian Balboa - * `PHP` - Philippine Peso + * `PGK` - Papua New Guinean Kina - * `XPT` - Platinum + * `PYG` - Paraguayan Guarani - * `PLN` - Polish Zloty + * `PEI` - Peruvian Inti - * `PLZ` - Polish Zloty (1950–1995) + * `PEN` - Peruvian Sol - * `PTE` - Portuguese Escudo + * `PES` - Peruvian Sol (1863–1965) - * `GWE` - Portuguese Guinea Escudo + * `PHP` - Philippine Peso - * `QAR` - Qatari Rial + * `XPT` - Platinum - * `XRE` - RINET Funds + * `PLN` - Polish Zloty - * `RHD` - Rhodesian Dollar + * `PLZ` - Polish Zloty (1950–1995) - * `RON` - Romanian Leu + * `PTE` - Portuguese Escudo - * `ROL` - Romanian Leu (1952–2006) + * `GWE` - Portuguese Guinea Escudo - * `RUB` - Russian Ruble + * `QAR` - Qatari Rial - * `RUR` - Russian Ruble (1991–1998) + * `XRE` - RINET Funds - * `RWF` - Rwandan Franc + * `RHD` - Rhodesian Dollar - * `SVC` - Salvadoran Colón + * `RON` - Romanian Leu - * `WST` - Samoan Tala + * `ROL` - Romanian Leu (1952–2006) - * `SAR` - Saudi Riyal + * `RUB` - Russian Ruble - * `RSD` - Serbian Dinar + * `RUR` - Russian Ruble (1991–1998) - * `CSD` - Serbian Dinar (2002–2006) + * `RWF` - Rwandan Franc - * `SCR` - Seychellois Rupee + * `SVC` - Salvadoran Colón - * `SLL` - Sierra Leonean Leone + * `WST` - Samoan Tala - * `XAG` - Silver + * `SAR` - Saudi Riyal - * `SGD` - Singapore Dollar + * `RSD` - Serbian Dinar - * `SKK` - Slovak Koruna + * `CSD` - Serbian Dinar (2002–2006) - * `SIT` - Slovenian Tolar + * `SCR` - Seychellois Rupee - * `SBD` - Solomon Islands Dollar + * `SLL` - Sierra Leonean Leone - * `SOS` - Somali Shilling + * `XAG` - Silver - * `ZAR` - South African Rand + * `SGD` - Singapore Dollar - * `ZAL` - South African Rand (financial) + * `SKK` - Slovak Koruna - * `KRH` - South Korean Hwan (1953–1962) + * `SIT` - Slovenian Tolar - * `KRW` - South Korean Won + * `SBD` - Solomon Islands Dollar - * `KRO` - South Korean Won (1945–1953) + * `SOS` - Somali Shilling - * `SSP` - South Sudanese Pound + * `ZAR` - South African Rand - * `SUR` - Soviet Rouble + * `ZAL` - South African Rand (financial) - * `ESP` - Spanish Peseta + * `KRH` - South Korean Hwan (1953–1962) - * `ESA` - Spanish Peseta (A account) + * `KRW` - South Korean Won - * `ESB` - Spanish Peseta (convertible account) + * `KRO` - South Korean Won (1945–1953) - * `XDR` - Special Drawing Rights + * `SSP` - South Sudanese Pound - * `LKR` - Sri Lankan Rupee + * `SUR` - Soviet Rouble - * `SHP` - St. Helena Pound + * `ESP` - Spanish Peseta - * `XSU` - Sucre + * `ESA` - Spanish Peseta (A account) - * `SDD` - Sudanese Dinar (1992–2007) + * `ESB` - Spanish Peseta (convertible account) - * `SDG` - Sudanese Pound + * `XDR` - Special Drawing Rights - * `SDP` - Sudanese Pound (1957–1998) + * `LKR` - Sri Lankan Rupee - * `SRD` - Surinamese Dollar + * `SHP` - St. Helena Pound - * `SRG` - Surinamese Guilder + * `XSU` - Sucre - * `SZL` - Swazi Lilangeni + * `SDD` - Sudanese Dinar (1992–2007) - * `SEK` - Swedish Krona + * `SDG` - Sudanese Pound - * `CHF` - Swiss Franc + * `SDP` - Sudanese Pound (1957–1998) - * `SYP` - Syrian Pound + * `SRD` - Surinamese Dollar - * `STN` - São Tomé & Príncipe Dobra + * `SRG` - Surinamese Guilder - * `STD` - São Tomé & Príncipe Dobra (1977–2017) + * `SZL` - Swazi Lilangeni - * `TVD` - TVD + * `SEK` - Swedish Krona - * `TJR` - Tajikistani Ruble + * `CHF` - Swiss Franc - * `TJS` - Tajikistani Somoni + * `SYP` - Syrian Pound - * `TZS` - Tanzanian Shilling + * `STN` - São Tomé & Príncipe Dobra - * `XTS` - Testing Currency Code + * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `THB` - Thai Baht + * `TVD` - TVD - * `XXX` - The codes assigned for transactions where no currency is - involved + * `TJR` - Tajikistani Ruble - * `TPE` - Timorese Escudo + * `TJS` - Tajikistani Somoni - * `TOP` - Tongan Paʻanga + * `TZS` - Tanzanian Shilling - * `TTD` - Trinidad & Tobago Dollar + * `XTS` - Testing Currency Code - * `TND` - Tunisian Dinar + * `THB` - Thai Baht - * `TRY` - Turkish Lira + * `XXX` - The codes assigned for transactions where no currency is + involved - * `TRL` - Turkish Lira (1922–2005) + * `TPE` - Timorese Escudo - * `TMT` - Turkmenistani Manat + * `TOP` - Tongan Paʻanga - * `TMM` - Turkmenistani Manat (1993–2009) + * `TTD` - Trinidad & Tobago Dollar - * `USD` - US Dollar + * `TND` - Tunisian Dinar - * `USN` - US Dollar (Next day) + * `TRY` - Turkish Lira - * `USS` - US Dollar (Same day) + * `TRL` - Turkish Lira (1922–2005) - * `UGX` - Ugandan Shilling + * `TMT` - Turkmenistani Manat - * `UGS` - Ugandan Shilling (1966–1987) + * `TMM` - Turkmenistani Manat (1993–2009) - * `UAH` - Ukrainian Hryvnia + * `USD` - US Dollar - * `UAK` - Ukrainian Karbovanets + * `USN` - US Dollar (Next day) - * `AED` - United Arab Emirates Dirham + * `USS` - US Dollar (Same day) - * `UYW` - Uruguayan Nominal Wage Index Unit + * `UGX` - Ugandan Shilling - * `UYU` - Uruguayan Peso + * `UGS` - Ugandan Shilling (1966–1987) - * `UYP` - Uruguayan Peso (1975–1993) + * `UAH` - Ukrainian Hryvnia - * `UYI` - Uruguayan Peso (Indexed Units) + * `UAK` - Ukrainian Karbovanets - * `UZS` - Uzbekistani Som + * `AED` - United Arab Emirates Dirham - * `VUV` - Vanuatu Vatu + * `UYW` - Uruguayan Nominal Wage Index Unit - * `VES` - Venezuelan Bolívar + * `UYU` - Uruguayan Peso - * `VEB` - Venezuelan Bolívar (1871–2008) + * `UYP` - Uruguayan Peso (1975–1993) - * `VEF` - Venezuelan Bolívar (2008–2018) + * `UYI` - Uruguayan Peso (Indexed Units) - * `VND` - Vietnamese Dong + * `UZS` - Uzbekistani Som - * `VNN` - Vietnamese Dong (1978–1985) + * `VUV` - Vanuatu Vatu - * `CHE` - WIR Euro + * `VES` - Venezuelan Bolívar - * `CHW` - WIR Franc + * `VEB` - Venezuelan Bolívar (1871–2008) - * `XOF` - West African CFA Franc + * `VEF` - Venezuelan Bolívar (2008–2018) - * `YDD` - Yemeni Dinar + * `VND` - Vietnamese Dong - * `YER` - Yemeni Rial + * `VNN` - Vietnamese Dong (1978–1985) - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `CHE` - WIR Euro - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `CHW` - WIR Franc - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `XOF` - West African CFA Franc - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `YDD` - Yemeni Dinar - * `ZWN` - ZWN + * `YER` - Yemeni Rial - * `ZRN` - Zairean New Zaire (1993–1998) + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `ZRZ` - Zairean Zaire (1971–1993) + * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `ZMW` - Zambian Kwacha + * `YUM` - Yugoslavian New Dinar (1994–2002) - * `ZMK` - Zambian Kwacha (1968–2012) + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `ZWN` - ZWN - * `ZWR` - Zimbabwean Dollar (2008) + * `ZRN` - Zairean New Zaire (1993–1998) - * `ZWL` - Zimbabwean Dollar (2009) - union: - - TransactionCurrencyEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - IncomeStatementCompany: - discriminated: false - docs: The company the income statement belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true - IncomeStatement: - docs: >- - # The IncomeStatement Object + * `ZRZ` - Zairean Zaire (1971–1993) - ### Description + * `ZMW` - Zambian Kwacha - The `IncomeStatement` object is used to represent a company’s income, the - cost of sales, operating expenses, and other non-operating expenses. The - object also includes other important values like gross profit, gross - operating profit, and net income. This represents a period of time (month, - quarter, or year). + * `ZMK` - Zambian Kwacha (1968–2012) + * `ZWD` - Zimbabwean Dollar (1980–2008) - ### Usage Example + * `ZWR` - Zimbabwean Dollar (2008) - Fetch from the `GET IncomeStatement` endpoint and view a company's income - statement for a given period. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - name: - type: optional - docs: The income statement's name. - currency: - type: optional + * `ZWL` - Zimbabwean Dollar (2009) + transaction_currency: + type: optional docs: >- - The income statement's currency. + The transaction currency that the transaction is made in. * `XUA` - ADB Unit of Account @@ -29115,36 +24734,24 @@ types: * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) - company: - type: optional - docs: The company the income statement belongs to. - start_period: - type: optional - docs: The income statement's start period. - end_period: - type: optional - docs: The income statement's end period. - income: - type: optional> - access: read-only - cost_of_sales: - type: optional> - access: read-only - gross_profit: - type: optional - docs: The revenue minus the cost of sale. - operating_expenses: - type: optional> - access: read-only - net_operating_income: - type: optional - docs: The revenue minus the operating expenses. - non_operating_expenses: - type: optional> + exchange_rate: + type: optional + docs: >- + The exchange rate between the base currency and the transaction + currency. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + description: + type: optional + docs: A description of the line item. + tracking_categories: + type: optional> access: read-only - net_income: - type: optional - docs: The gross profit minus the total expenses. + debit_amount: string + credit_amount: string + item: optional + foreign_debit_amount: string + foreign_credit_amount: string remote_was_deleted: type: optional docs: >- @@ -29157,82 +24764,12 @@ types: field_mappings: type: optional> access: read-only - remote_data: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - IndividualCommonModelScopeDeserializer: - properties: - model_name: string - model_permissions: optional> - field_permissions: optional source: openapi: openapi/openapi.yml - IndividualCommonModelScopeDeserializerRequest: - properties: - model_name: - type: string - validation: - minLength: 1 - model_permissions: optional> - field_permissions: optional - source: - openapi: openapi/openapi.yml - InvoiceType: - discriminated: false - docs: >- - Whether the invoice is an accounts receivable or accounts payable. If - `type` is `ACCOUNTS_PAYABLE`, the invoice is a bill. If `type` is - `ACCOUNTS_RECEIVABLE`, it is an invoice. - - - * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE - - * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE - union: - - InvoiceTypeEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - InvoiceContact: - discriminated: false - docs: The invoice's contact. - union: - - type: string - validation: - format: uuid - - Contact - source: - openapi: openapi/openapi.yml - inline: true - InvoiceCompany: - discriminated: false - docs: The company the invoice belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true - InvoiceEmployee: - discriminated: false - docs: The employee this overall transaction relates to. - union: - - type: string - validation: - format: uuid - - Employee - source: - openapi: openapi/openapi.yml - inline: true - InvoiceCurrency: + IncomeStatementCurrency: discriminated: false docs: >- - The invoice's currency. + The income statement's currency. * `XUA` - ADB Unit of Account @@ -29853,123 +25390,34 @@ types: source: openapi: openapi/openapi.yml inline: true - InvoicePaymentTerm: - discriminated: false - docs: The payment term that applies to this transaction. - union: - - type: string - validation: - format: uuid - - PaymentTerm - source: - openapi: openapi/openapi.yml - inline: true - InvoiceStatus: - discriminated: false - docs: |- - The status of the invoice. - - * `PAID` - PAID - * `DRAFT` - DRAFT - * `SUBMITTED` - SUBMITTED - * `PARTIALLY_PAID` - PARTIALLY_PAID - * `OPEN` - OPEN - * `VOID` - VOID - union: - - InvoiceStatusEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - InvoiceTrackingCategoriesItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - TrackingCategory - source: - openapi: openapi/openapi.yml - inline: true - InvoiceAccountingPeriod: - discriminated: false - docs: The accounting period that the Invoice was generated in. - union: - - type: string - validation: - format: uuid - - AccountingPeriod - source: - openapi: openapi/openapi.yml - inline: true - InvoicePurchaseOrdersItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - PurchaseOrder - source: - openapi: openapi/openapi.yml - inline: true - InvoicePaymentsItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - Payment - source: - openapi: openapi/openapi.yml - inline: true - InvoiceAppliedPaymentsItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - PaymentLineItem - source: - openapi: openapi/openapi.yml - inline: true - InvoiceAppliedCreditNotesItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - CreditNoteApplyLineForInvoice - source: - openapi: openapi/openapi.yml - inline: true - InvoiceAppliedVendorCreditsItem: + IncomeStatementCompany: discriminated: false + docs: The company the income statement belongs to. union: - type: string validation: format: uuid - - VendorCreditApplyLineForInvoice + - CompanyInfo source: openapi: openapi/openapi.yml inline: true - Invoice: + IncomeStatement: docs: >- - # The Invoice Object + # The IncomeStatement Object ### Description - The `Invoice` object represents an itemized record of goods and/or - services sold to a customer or bought from a vendor. - - - - Represents a Bill when the `Invoice` type is `ACCOUNTS_PAYABLE`. - References an Invoice when the `Invoice` type is `ACCOUNTS_RECEIVABLE`. + The `IncomeStatement` object is used to represent a company’s income, the + cost of sales, operating expenses, and other non-operating expenses. The + object also includes other important values like gross profit, gross + operating profit, and net income. This represents a period of time (month, + quarter, or year). ### Usage Example - Fetch from the `LIST Invoices` endpoint and view a company's invoices. + Fetch from the `GET IncomeStatement` endpoint and view a company's income + statement for a given period. properties: id: type: optional @@ -29987,45 +25435,13 @@ types: type: optional docs: The datetime that this object was modified by Merge. access: read-only - type: - type: optional - docs: >- - Whether the invoice is an accounts receivable or accounts payable. If - `type` is `ACCOUNTS_PAYABLE`, the invoice is a bill. If `type` is - `ACCOUNTS_RECEIVABLE`, it is an invoice. - - - * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE - - * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE - contact: - type: optional - docs: The invoice's contact. - number: - type: optional - docs: The invoice's number. - issue_date: - type: optional - docs: The invoice's issue date. - due_date: - type: optional - docs: The invoice's due date. - paid_on_date: - type: optional - docs: The invoice's paid date. - memo: + name: type: optional - docs: The invoice's private note. - company: - type: optional - docs: The company the invoice belongs to. - employee: - type: optional - docs: The employee this overall transaction relates to. + docs: The income statement's name. currency: - type: optional + type: optional docs: >- - The invoice's currency. + The income statement's currency. * `XUA` - ADB Unit of Account @@ -30640,72 +26056,36 @@ types: * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) - exchange_rate: - type: optional - docs: The invoice's exchange rate. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - payment_term: - type: optional - docs: The payment term that applies to this transaction. - total_discount: - type: optional - docs: The total discounts applied to the total cost. - sub_total: - type: optional - docs: The total amount being paid before taxes. - status: - type: optional - docs: |- - The status of the invoice. - - * `PAID` - PAID - * `DRAFT` - DRAFT - * `SUBMITTED` - SUBMITTED - * `PARTIALLY_PAID` - PARTIALLY_PAID - * `OPEN` - OPEN - * `VOID` - VOID - total_tax_amount: - type: optional - docs: The total amount being paid in taxes. - total_amount: - type: optional - docs: The invoice's total amount. - balance: - type: optional - docs: The invoice's remaining balance. - remote_updated_at: + company: + type: optional + docs: The company the income statement belongs to. + start_period: type: optional - docs: When the third party's invoice entry was updated. - tracking_categories: optional>> - accounting_period: - type: optional - docs: The accounting period that the Invoice was generated in. - purchase_orders: optional>> - payments: - type: optional>> - docs: Array of `Payment` object IDs. - applied_payments: - type: optional>> - docs: >- - A list of the Payment Applied to Lines common models related to a - given Invoice, Credit Note, or Journal Entry. - line_items: - type: optional> + docs: The income statement's start period. + end_period: + type: optional + docs: The income statement's end period. + income: + type: optional> access: read-only - applied_credit_notes: - type: optional> - docs: '`CreditNoteApplyLines` applied to the Invoice.' + cost_of_sales: + type: optional> access: read-only - applied_vendor_credits: - type: optional> - docs: '`VendorCreditApplyLines` applied to the Invoice.' + gross_profit: + type: optional + docs: The revenue minus the cost of sale. + operating_expenses: + type: optional> access: read-only - inclusive_of_tax: - type: optional - docs: >- - If the transaction is inclusive or exclusive of tax. `True` if - inclusive, `False` if exclusive. + net_operating_income: + type: optional + docs: The revenue minus the operating expenses. + non_operating_expenses: + type: optional> + access: read-only + net_income: + type: optional + docs: The gross profit minus the total expenses. remote_was_deleted: type: optional docs: >- @@ -30721,47 +26101,79 @@ types: remote_data: type: optional> access: read-only - remote_fields: - type: optional> - access: read-only source: openapi: openapi/openapi.yml - InvoiceLineItemEmployee: + IndividualCommonModelScopeDeserializer: + properties: + model_name: string + model_permissions: optional> + field_permissions: optional + source: + openapi: openapi/openapi.yml + IndividualCommonModelScopeDeserializerRequest: + properties: + model_name: + type: string + validation: + minLength: 1 + model_permissions: optional> + field_permissions: optional + source: + openapi: openapi/openapi.yml + InvoiceType: discriminated: false - docs: The employee this overall transaction relates to. + docs: >- + Whether the invoice is an accounts receivable or accounts payable. If + `type` is `ACCOUNTS_PAYABLE`, the invoice is a bill. If `type` is + `ACCOUNTS_RECEIVABLE`, it is an invoice. + + + * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE + + * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE + union: + - InvoiceTypeEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + InvoiceContact: + discriminated: false + docs: The invoice's contact. union: - type: string validation: format: uuid - - Employee + - Contact source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemProject: + InvoiceCompany: discriminated: false + docs: The company the invoice belongs to. union: - type: string validation: format: uuid - - Project + - CompanyInfo source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemContact: + InvoiceEmployee: discriminated: false - docs: The invoice's contact. + docs: The employee this overall transaction relates to. union: - type: string validation: format: uuid - - Contact + - Employee source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemCurrency: + InvoiceCurrency: discriminated: false docs: >- - The line item's currency. + The invoice's currency. * `XUA` - ADB Unit of Account @@ -31382,59 +26794,123 @@ types: source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemItem: + InvoicePaymentTerm: discriminated: false + docs: The payment term that applies to this transaction. union: - type: string validation: format: uuid - - Item + - PaymentTerm source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemAccount: + InvoiceStatus: + discriminated: false + docs: |- + The status of the invoice. + + * `PAID` - PAID + * `DRAFT` - DRAFT + * `SUBMITTED` - SUBMITTED + * `PARTIALLY_PAID` - PARTIALLY_PAID + * `OPEN` - OPEN + * `VOID` - VOID + union: + - InvoiceStatusEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + InvoiceTrackingCategoriesItem: discriminated: false union: - type: string validation: format: uuid - - Account + - TrackingCategory source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemTrackingCategory: + InvoiceAccountingPeriod: discriminated: false + docs: The accounting period that the Invoice was generated in. union: - type: string validation: format: uuid - - TrackingCategory + - AccountingPeriod source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemTrackingCategoriesItem: + InvoicePurchaseOrdersItem: discriminated: false union: - type: string validation: format: uuid - - TrackingCategory + - PurchaseOrder source: openapi: openapi/openapi.yml inline: true - InvoiceLineItem: + InvoicePaymentsItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - Payment + source: + openapi: openapi/openapi.yml + inline: true + InvoiceAppliedPaymentsItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - PaymentLineItem + source: + openapi: openapi/openapi.yml + inline: true + InvoiceAppliedCreditNotesItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - CreditNoteApplyLineForInvoice + source: + openapi: openapi/openapi.yml + inline: true + InvoiceAppliedVendorCreditsItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - VendorCreditApplyLineForInvoice + source: + openapi: openapi/openapi.yml + inline: true + Invoice: docs: >- - # The InvoiceLineItem Object + # The Invoice Object ### Description - The `InvoiceLineItem` object represents an itemized record of goods and/or - services sold to a customer. + The `Invoice` object represents an itemized record of goods and/or + services sold to a customer or bought from a vendor. + + + + Represents a Bill when the `Invoice` type is `ACCOUNTS_PAYABLE`. + References an Invoice when the `Invoice` type is `ACCOUNTS_RECEIVABLE`. ### Usage Example - Fetch from the `GET Invoice` endpoint and view the invoice's line items. + Fetch from the `LIST Invoices` endpoint and view a company's invoices. properties: id: type: optional @@ -31452,29 +26928,45 @@ types: type: optional docs: The datetime that this object was modified by Merge. access: read-only - description: + type: + type: optional + docs: >- + Whether the invoice is an accounts receivable or accounts payable. If + `type` is `ACCOUNTS_PAYABLE`, the invoice is a bill. If `type` is + `ACCOUNTS_RECEIVABLE`, it is an invoice. + + + * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE + + * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE + contact: + type: optional + docs: The invoice's contact. + number: type: optional - docs: The line item's description. - unit_price: - type: optional - docs: The line item's unit price. - quantity: - type: optional - docs: The line item's quantity. - total_amount: - type: optional - docs: The line item's total amount. + docs: The invoice's number. + issue_date: + type: optional + docs: The invoice's issue date. + due_date: + type: optional + docs: The invoice's due date. + paid_on_date: + type: optional + docs: The invoice's paid date. + memo: + type: optional + docs: The invoice's private note. + company: + type: optional + docs: The company the invoice belongs to. employee: - type: optional + type: optional docs: The employee this overall transaction relates to. - project: optional - contact: - type: optional - docs: The invoice's contact. currency: - type: optional + type: optional docs: >- - The line item's currency. + The invoice's currency. * `XUA` - ADB Unit of Account @@ -32091,27 +27583,70 @@ types: * `ZWL` - Zimbabwean Dollar (2009) exchange_rate: type: optional - docs: The line item's exchange rate. + docs: The invoice's exchange rate. validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - item: optional - account: optional - tax_rate: - type: optional - docs: The tax rate that applies to this line item. - validation: - format: uuid - tracking_category: - type: optional - availability: deprecated - tracking_categories: - type: optional>> - docs: The invoice line item's associated tracking categories. - company: - type: optional - docs: The company the invoice belongs to. - validation: - format: uuid + payment_term: + type: optional + docs: The payment term that applies to this transaction. + total_discount: + type: optional + docs: The total discounts applied to the total cost. + sub_total: + type: optional + docs: The total amount being paid before taxes. + status: + type: optional + docs: |- + The status of the invoice. + + * `PAID` - PAID + * `DRAFT` - DRAFT + * `SUBMITTED` - SUBMITTED + * `PARTIALLY_PAID` - PARTIALLY_PAID + * `OPEN` - OPEN + * `VOID` - VOID + total_tax_amount: + type: optional + docs: The total amount being paid in taxes. + total_amount: + type: optional + docs: The invoice's total amount. + balance: + type: optional + docs: The invoice's remaining balance. + remote_updated_at: + type: optional + docs: When the third party's invoice entry was updated. + tracking_categories: optional>> + accounting_period: + type: optional + docs: The accounting period that the Invoice was generated in. + purchase_orders: optional>> + payments: + type: optional>> + docs: Array of `Payment` object IDs. + applied_payments: + type: optional>> + docs: >- + A list of the Payment Applied to Lines common models related to a + given Invoice, Credit Note, or Journal Entry. + line_items: + type: optional> + access: read-only + applied_credit_notes: + type: optional> + docs: '`CreditNoteApplyLines` applied to the Invoice.' + access: read-only + applied_vendor_credits: + type: optional> + docs: '`VendorCreditApplyLines` applied to the Invoice.' + access: read-only + inclusive_of_tax: + type: optional + docs: >- + If the transaction is inclusive or exclusive of tax. `True` if + inclusive, `False` if exclusive. remote_was_deleted: type: optional docs: >- @@ -32124,12 +27659,15 @@ types: field_mappings: type: optional> access: read-only + remote_data: + type: optional> + access: read-only remote_fields: type: optional> access: read-only source: openapi: openapi/openapi.yml - InvoiceLineItemRequestEmployee: + InvoiceLineItemEmployee: discriminated: false docs: The employee this overall transaction relates to. union: @@ -32140,7 +27678,7 @@ types: source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemRequestProject: + InvoiceLineItemProject: discriminated: false union: - type: string @@ -32150,7 +27688,7 @@ types: source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemRequestContact: + InvoiceLineItemContact: discriminated: false docs: The invoice's contact. union: @@ -32161,7 +27699,7 @@ types: source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemRequestCurrency: + InvoiceLineItemCurrency: discriminated: false docs: >- The line item's currency. @@ -32785,7 +28323,7 @@ types: source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemRequestItem: + InvoiceLineItemItem: discriminated: false union: - type: string @@ -32795,7 +28333,7 @@ types: source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemRequestAccount: + InvoiceLineItemAccount: discriminated: false union: - type: string @@ -32805,7 +28343,7 @@ types: source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemRequestTrackingCategory: + InvoiceLineItemTrackingCategory: discriminated: false union: - type: string @@ -32815,7 +28353,7 @@ types: source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemRequestTrackingCategoriesItem: + InvoiceLineItemTrackingCategoriesItem: discriminated: false union: - type: string @@ -32825,7 +28363,7 @@ types: source: openapi: openapi/openapi.yml inline: true - InvoiceLineItemRequest: + InvoiceLineItem: docs: >- # The InvoiceLineItem Object @@ -32839,9 +28377,22 @@ types: Fetch from the `GET Invoice` endpoint and view the invoice's line items. properties: + id: + type: optional + validation: + format: uuid + access: read-only remote_id: type: optional docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only description: type: optional docs: The line item's description. @@ -32855,14 +28406,14 @@ types: type: optional docs: The line item's total amount. employee: - type: optional + type: optional docs: The employee this overall transaction relates to. - project: optional + project: optional contact: - type: optional + type: optional docs: The invoice's contact. currency: - type: optional + type: optional docs: >- The line item's currency. @@ -33484,106 +29035,77 @@ types: docs: The line item's exchange rate. validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - item: optional - account: optional + item: optional + account: optional tax_rate: type: optional docs: The tax rate that applies to this line item. validation: format: uuid tracking_category: - type: optional + type: optional availability: deprecated tracking_categories: - type: optional>> + type: optional>> docs: The invoice line item's associated tracking categories. company: type: optional docs: The company the invoice belongs to. validation: format: uuid - integration_params: - type: optional> - access: write-only - linked_account_params: + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + field_mappings: type: optional> - access: write-only + access: read-only remote_fields: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - InvoiceRequestType: - discriminated: false - docs: >- - Whether the invoice is an accounts receivable or accounts payable. If - `type` is `ACCOUNTS_PAYABLE`, the invoice is a bill. If `type` is - `ACCOUNTS_RECEIVABLE`, it is an invoice. - - - * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE - - * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE - union: - - InvoiceTypeEnum - - string + type: optional> + access: read-only source: openapi: openapi/openapi.yml - inline: true - InvoiceRequestContact: + InvoiceLineItemRequestEmployee: discriminated: false - docs: The invoice's contact. + docs: The employee this overall transaction relates to. union: - type: string validation: format: uuid - - Contact + - Employee source: openapi: openapi/openapi.yml inline: true - InvoiceRequestEmployee: + InvoiceLineItemRequestProject: discriminated: false - docs: The employee this overall transaction relates to. union: - type: string validation: format: uuid - - Employee - source: - openapi: openapi/openapi.yml - inline: true - InvoiceRequestStatus: - discriminated: false - docs: |- - The status of the invoice. - - * `PAID` - PAID - * `DRAFT` - DRAFT - * `SUBMITTED` - SUBMITTED - * `PARTIALLY_PAID` - PARTIALLY_PAID - * `OPEN` - OPEN - * `VOID` - VOID - union: - - InvoiceStatusEnum - - string + - Project source: openapi: openapi/openapi.yml inline: true - InvoiceRequestCompany: + InvoiceLineItemRequestContact: discriminated: false - docs: The company the invoice belongs to. + docs: The invoice's contact. union: - type: string validation: format: uuid - - CompanyInfo + - Contact source: openapi: openapi/openapi.yml inline: true - InvoiceRequestCurrency: + InvoiceLineItemRequestCurrency: discriminated: false docs: >- - The invoice's currency. + The line item's currency. * `XUA` - ADB Unit of Account @@ -34204,28 +29726,27 @@ types: source: openapi: openapi/openapi.yml inline: true - InvoiceRequestPaymentTerm: + InvoiceLineItemRequestItem: discriminated: false - docs: The payment term that applies to this transaction. union: - type: string validation: format: uuid - - PaymentTerm + - Item source: openapi: openapi/openapi.yml inline: true - InvoiceRequestPaymentsItem: + InvoiceLineItemRequestAccount: discriminated: false union: - type: string validation: format: uuid - - Payment + - Account source: openapi: openapi/openapi.yml inline: true - InvoiceRequestTrackingCategoriesItem: + InvoiceLineItemRequestTrackingCategory: discriminated: false union: - type: string @@ -34235,85 +29756,56 @@ types: source: openapi: openapi/openapi.yml inline: true - InvoiceRequestPurchaseOrdersItem: + InvoiceLineItemRequestTrackingCategoriesItem: discriminated: false union: - type: string validation: format: uuid - - PurchaseOrder + - TrackingCategory source: openapi: openapi/openapi.yml inline: true - InvoiceRequest: + InvoiceLineItemRequest: docs: >- - # The Invoice Object + # The InvoiceLineItem Object ### Description - The `Invoice` object represents an itemized record of goods and/or - services sold to a customer or bought from a vendor. - - - - Represents a Bill when the `Invoice` type is `ACCOUNTS_PAYABLE`. - References an Invoice when the `Invoice` type is `ACCOUNTS_RECEIVABLE`. + The `InvoiceLineItem` object represents an itemized record of goods and/or + services sold to a customer. ### Usage Example - Fetch from the `LIST Invoices` endpoint and view a company's invoices. + Fetch from the `GET Invoice` endpoint and view the invoice's line items. properties: - type: - type: optional - docs: >- - Whether the invoice is an accounts receivable or accounts payable. If - `type` is `ACCOUNTS_PAYABLE`, the invoice is a bill. If `type` is - `ACCOUNTS_RECEIVABLE`, it is an invoice. - - - * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE - - * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE - contact: - type: optional - docs: The invoice's contact. - number: + remote_id: type: optional - docs: The invoice's number. - issue_date: - type: optional - docs: The invoice's issue date. - due_date: - type: optional - docs: The invoice's due date. - paid_on_date: - type: optional - docs: The invoice's paid date. + docs: The third-party API ID of the matching object. + description: + type: optional + docs: The line item's description. + unit_price: + type: optional + docs: The line item's unit price. + quantity: + type: optional + docs: The line item's quantity. + total_amount: + type: optional + docs: The line item's total amount. employee: - type: optional + type: optional docs: The employee this overall transaction relates to. - memo: - type: optional - docs: The invoice's private note. - status: - type: optional - docs: |- - The status of the invoice. - - * `PAID` - PAID - * `DRAFT` - DRAFT - * `SUBMITTED` - SUBMITTED - * `PARTIALLY_PAID` - PARTIALLY_PAID - * `OPEN` - OPEN - * `VOID` - VOID - company: - type: optional - docs: The company the invoice belongs to. + project: optional + contact: + type: optional + docs: The invoice's contact. currency: - type: optional + type: optional docs: >- - The invoice's currency. + The line item's currency. * `XUA` - ADB Unit of Account @@ -34899,545 +30391,140 @@ types: * `CHW` - WIR Franc - * `XOF` - West African CFA Franc - - * `YDD` - Yemeni Dinar - - * `YER` - Yemeni Rial - - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - - * `YUM` - Yugoslavian New Dinar (1994–2002) - - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - - * `ZWN` - ZWN - - * `ZRN` - Zairean New Zaire (1993–1998) - - * `ZRZ` - Zairean Zaire (1971–1993) - - * `ZMW` - Zambian Kwacha - - * `ZMK` - Zambian Kwacha (1968–2012) - - * `ZWD` - Zimbabwean Dollar (1980–2008) - - * `ZWR` - Zimbabwean Dollar (2008) - - * `ZWL` - Zimbabwean Dollar (2009) - exchange_rate: - type: optional - docs: The invoice's exchange rate. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - total_discount: - type: optional - docs: The total discounts applied to the total cost. - sub_total: - type: optional - docs: The total amount being paid before taxes. - payment_term: - type: optional - docs: The payment term that applies to this transaction. - total_tax_amount: - type: optional - docs: The total amount being paid in taxes. - inclusive_of_tax: - type: optional - docs: >- - If the transaction is inclusive or exclusive of tax. `True` if - inclusive, `False` if exclusive. - total_amount: - type: optional - docs: The invoice's total amount. - balance: - type: optional - docs: The invoice's remaining balance. - payments: - type: optional>> - docs: Array of `Payment` object IDs. - tracking_categories: optional>> - line_items: optional> - purchase_orders: optional>> - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - remote_fields: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - InvoiceResponse: - properties: - model: Invoice - warnings: list - errors: list - logs: optional> - source: - openapi: openapi/openapi.yml - InvoiceStatusEnum: - enum: - - PAID - - DRAFT - - SUBMITTED - - PARTIALLY_PAID - - OPEN - - VOID - docs: |- - * `PAID` - PAID - * `DRAFT` - DRAFT - * `SUBMITTED` - SUBMITTED - * `PARTIALLY_PAID` - PARTIALLY_PAID - * `OPEN` - OPEN - * `VOID` - VOID - source: - openapi: openapi/openapi.yml - InvoiceTypeEnum: - enum: - - ACCOUNTS_RECEIVABLE - - ACCOUNTS_PAYABLE - docs: |- - * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE - * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE - source: - openapi: openapi/openapi.yml - IssueStatus: - discriminated: false - docs: |- - Status of the issue. Options: ('ONGOING', 'RESOLVED') - - * `ONGOING` - ONGOING - * `RESOLVED` - RESOLVED - union: - - IssueStatusEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - Issue: - properties: - id: - type: optional - validation: - format: uuid - access: read-only - status: - type: optional - docs: |- - Status of the issue. Options: ('ONGOING', 'RESOLVED') - - * `ONGOING` - ONGOING - * `RESOLVED` - RESOLVED - error_description: string - end_user: - type: optional> - access: read-only - first_incident_time: optional - last_incident_time: optional - is_muted: - type: optional - access: read-only - error_details: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - IssueStatusEnum: - enum: - - ONGOING - - RESOLVED - docs: |- - * `ONGOING` - ONGOING - * `RESOLVED` - RESOLVED - source: - openapi: openapi/openapi.yml - ItemStatus: - discriminated: false - docs: |- - The item's status. - - * `ACTIVE` - ACTIVE - * `ARCHIVED` - ARCHIVED - union: - - Status7D1Enum - - string - source: - openapi: openapi/openapi.yml - inline: true - ItemType: - discriminated: false - docs: |- - The item's type. + * `XOF` - West African CFA Franc - * `INVENTORY` - INVENTORY - * `NON_INVENTORY` - NON_INVENTORY - * `SERVICE` - SERVICE - * `UNKNOWN` - UNKNOWN - union: - - Type2BbEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - ItemPurchaseAccount: - discriminated: false - docs: References the default account used to record a purchase of the item. - union: - - type: string - validation: - format: uuid - - Account - source: - openapi: openapi/openapi.yml - inline: true - ItemSalesAccount: - discriminated: false - docs: References the default account used to record a sale. - union: - - type: string - validation: - format: uuid - - Account - source: - openapi: openapi/openapi.yml - inline: true - ItemCompany: - discriminated: false - docs: The company the item belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true - ItemPurchaseTaxRate: - discriminated: false - docs: The default purchase tax rate for this item. - union: - - type: string + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) + exchange_rate: + type: optional + docs: The line item's exchange rate. validation: - format: uuid - - TaxRate - source: - openapi: openapi/openapi.yml - inline: true - ItemSalesTaxRate: - discriminated: false - docs: The default sales tax rate for this item. - union: - - type: string + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + item: optional + account: optional + tax_rate: + type: optional + docs: The tax rate that applies to this line item. validation: format: uuid - - TaxRate - source: - openapi: openapi/openapi.yml - inline: true - Item: - docs: |- - # The Item Object - ### Description - The `Item` object refers to the goods involved in a transaction. - - ### Usage Example - Fetch from the `LIST Items` endpoint and view a company's items. - properties: - id: + tracking_category: + type: optional + availability: deprecated + tracking_categories: + type: optional>> + docs: The invoice line item's associated tracking categories. + company: type: optional + docs: The company the invoice belongs to. validation: format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - name: - type: optional - docs: The item's name. - status: - type: optional - docs: |- - The item's status. - - * `ACTIVE` - ACTIVE - * `ARCHIVED` - ARCHIVED - type: - type: optional - docs: |- - The item's type. - - * `INVENTORY` - INVENTORY - * `NON_INVENTORY` - NON_INVENTORY - * `SERVICE` - SERVICE - * `UNKNOWN` - UNKNOWN - unit_price: - type: optional - docs: The item's unit price. - purchase_price: - type: optional - docs: The price at which the item is purchased from a vendor. - purchase_account: - type: optional - docs: References the default account used to record a purchase of the item. - sales_account: - type: optional - docs: References the default account used to record a sale. - company: - type: optional - docs: The company the item belongs to. - purchase_tax_rate: - type: optional - docs: The default purchase tax rate for this item. - sales_tax_rate: - type: optional - docs: The default sales tax rate for this item. - remote_updated_at: - type: optional - docs: When the third party's item note was updated. - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - field_mappings: + integration_params: type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - ItemFormatEnum: - enum: - - string - - number - - date - - datetime - - bool - - list - docs: |- - * `string` - uuid - * `number` - url - * `date` - email - * `datetime` - phone - * `bool` - currency - * `list` - decimal + access: write-only + linked_account_params: + type: optional> + access: write-only + remote_fields: + type: optional> + access: write-only source: openapi: openapi/openapi.yml - ItemRequestRequestStatus: + InvoiceRequestType: discriminated: false - docs: |- - The item's status. + docs: >- + Whether the invoice is an accounts receivable or accounts payable. If + `type` is `ACCOUNTS_PAYABLE`, the invoice is a bill. If `type` is + `ACCOUNTS_RECEIVABLE`, it is an invoice. - * `ACTIVE` - ACTIVE - * `ARCHIVED` - ARCHIVED - union: - - Status7D1Enum - - string - source: - openapi: openapi/openapi.yml - inline: true - ItemRequestRequestType: - discriminated: false - docs: |- - The item's type. - * `INVENTORY` - INVENTORY - * `NON_INVENTORY` - NON_INVENTORY - * `SERVICE` - SERVICE - * `UNKNOWN` - UNKNOWN + * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE + + * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE union: - - Type2BbEnum + - InvoiceTypeEnum - string source: openapi: openapi/openapi.yml inline: true - ItemRequestRequestPurchaseAccount: - discriminated: false - docs: References the default account used to record a purchase of the item. - union: - - type: string - validation: - format: uuid - - Account - source: - openapi: openapi/openapi.yml - inline: true - ItemRequestRequestSalesAccount: - discriminated: false - docs: References the default account used to record a sale. - union: - - type: string - validation: - format: uuid - - Account - source: - openapi: openapi/openapi.yml - inline: true - ItemRequestRequestCompany: + InvoiceRequestContact: discriminated: false - docs: The company the item belongs to. + docs: The invoice's contact. union: - type: string validation: format: uuid - - CompanyInfo + - Contact source: openapi: openapi/openapi.yml inline: true - ItemRequestRequestPurchaseTaxRate: + InvoiceRequestEmployee: discriminated: false - docs: The default purchase tax rate for this item. + docs: The employee this overall transaction relates to. union: - type: string validation: format: uuid - - TaxRate + - Employee source: openapi: openapi/openapi.yml inline: true - ItemRequestRequestSalesTaxRate: + InvoiceRequestStatus: discriminated: false - docs: The default sales tax rate for this item. - union: - - type: string - validation: - format: uuid - - TaxRate - source: - openapi: openapi/openapi.yml - inline: true - ItemRequestRequest: docs: |- - # The Item Object - ### Description - The `Item` object refers to the goods involved in a transaction. - - ### Usage Example - Fetch from the `LIST Items` endpoint and view a company's items. - properties: - name: - type: optional - docs: The item's name. - status: - type: optional - docs: |- - The item's status. - - * `ACTIVE` - ACTIVE - * `ARCHIVED` - ARCHIVED - type: - type: optional - docs: |- - The item's type. + The status of the invoice. - * `INVENTORY` - INVENTORY - * `NON_INVENTORY` - NON_INVENTORY - * `SERVICE` - SERVICE - * `UNKNOWN` - UNKNOWN - unit_price: - type: optional - docs: The item's unit price. - purchase_price: - type: optional - docs: The price at which the item is purchased from a vendor. - purchase_account: - type: optional - docs: References the default account used to record a purchase of the item. - sales_account: - type: optional - docs: References the default account used to record a sale. - company: - type: optional - docs: The company the item belongs to. - purchase_tax_rate: - type: optional - docs: The default purchase tax rate for this item. - sales_tax_rate: - type: optional - docs: The default sales tax rate for this item. - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - ItemResponse: - properties: - model: Item - warnings: list - errors: list - logs: optional> - source: - openapi: openapi/openapi.yml - ItemSchema: - properties: - item_type: optional - item_format: optional - item_choices: optional> - source: - openapi: openapi/openapi.yml - ItemTypeEnum: - enum: - - string - - number - - date - - datetime - - bool - - list - docs: |- - * `string` - string - * `number` - number - * `date` - date - * `datetime` - datetime - * `bool` - bool - * `list` - list - source: - openapi: openapi/openapi.yml - JournalEntryPaymentsItem: - discriminated: false + * `PAID` - PAID + * `DRAFT` - DRAFT + * `SUBMITTED` - SUBMITTED + * `PARTIALLY_PAID` - PARTIALLY_PAID + * `OPEN` - OPEN + * `VOID` - VOID union: - - type: string - validation: - format: uuid - - Payment + - InvoiceStatusEnum + - string source: openapi: openapi/openapi.yml inline: true - JournalEntryAppliedPaymentsItem: + InvoiceRequestCompany: discriminated: false + docs: The company the invoice belongs to. union: - type: string validation: format: uuid - - PaymentLineItem + - CompanyInfo source: openapi: openapi/openapi.yml inline: true - JournalEntryCurrency: + InvoiceRequestCurrency: discriminated: false docs: >- - The journal's currency. + The invoice's currency. * `XUA` - ADB Unit of Account @@ -36058,110 +31145,116 @@ types: source: openapi: openapi/openapi.yml inline: true - JournalEntryCompany: + InvoiceRequestPaymentTerm: discriminated: false - docs: The company the journal entry belongs to. + docs: The payment term that applies to this transaction. union: - type: string validation: format: uuid - - CompanyInfo + - PaymentTerm source: openapi: openapi/openapi.yml inline: true - JournalEntryTrackingCategoriesItem: + InvoiceRequestPaymentsItem: discriminated: false union: - type: string validation: format: uuid - - TrackingCategory + - Payment source: openapi: openapi/openapi.yml inline: true - JournalEntryPostingStatus: + InvoiceRequestTrackingCategoriesItem: discriminated: false - docs: |- - The journal's posting status. - - * `UNPOSTED` - UNPOSTED - * `POSTED` - POSTED union: - - PostingStatusEnum - - string + - type: string + validation: + format: uuid + - TrackingCategory source: openapi: openapi/openapi.yml inline: true - JournalEntryAccountingPeriod: + InvoiceRequestPurchaseOrdersItem: discriminated: false - docs: The accounting period that the JournalEntry was generated in. union: - type: string validation: format: uuid - - AccountingPeriod + - PurchaseOrder source: openapi: openapi/openapi.yml inline: true - JournalEntry: + InvoiceRequest: docs: >- - # The JournalEntry Object + # The Invoice Object ### Description - A `JournalEntry` is a record of a transaction or event that is entered - into a company's accounting system. - + The `Invoice` object represents an itemized record of goods and/or + services sold to a customer or bought from a vendor. - The `JournalEntry` common model contains records that are automatically - created as a result of a certain type of transaction, like an Invoice, and - records that are manually created against a company’s ledger. - The lines of a given `JournalEntry` object should always sum to 0. A - positive `net_amount` means the line represents a debit and a negative - net_amount represents a credit. + Represents a Bill when the `Invoice` type is `ACCOUNTS_PAYABLE`. + References an Invoice when the `Invoice` type is `ACCOUNTS_RECEIVABLE`. ### Usage Example - Fetch from the `GET JournalEntry` endpoint and view a company's journey - entry. + Fetch from the `LIST Invoices` endpoint and view a company's invoices. properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: + type: + type: optional + docs: >- + Whether the invoice is an accounts receivable or accounts payable. If + `type` is `ACCOUNTS_PAYABLE`, the invoice is a bill. If `type` is + `ACCOUNTS_RECEIVABLE`, it is an invoice. + + + * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE + + * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE + contact: + type: optional + docs: The invoice's contact. + number: type: optional - docs: The third-party API ID of the matching object. - created_at: + docs: The invoice's number. + issue_date: type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: + docs: The invoice's issue date. + due_date: type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - transaction_date: + docs: The invoice's due date. + paid_on_date: type: optional - docs: The journal entry's transaction date. - payments: - type: optional>> - docs: Array of `Payment` object IDs. - applied_payments: - type: optional>> - docs: >- - A list of the Payment Applied to Lines common models related to a - given Invoice, Credit Note, or Journal Entry. + docs: The invoice's paid date. + employee: + type: optional + docs: The employee this overall transaction relates to. memo: type: optional - docs: The journal entry's private note. + docs: The invoice's private note. + status: + type: optional + docs: |- + The status of the invoice. + + * `PAID` - PAID + * `DRAFT` - DRAFT + * `SUBMITTED` - SUBMITTED + * `PARTIALLY_PAID` - PARTIALLY_PAID + * `OPEN` - OPEN + * `VOID` - VOID + company: + type: optional + docs: The company the invoice belongs to. currency: - type: optional + type: optional docs: >- - The journal's currency. + The invoice's currency. * `XUA` - ADB Unit of Account @@ -36778,26 +31871,284 @@ types: * `ZWL` - Zimbabwean Dollar (2009) exchange_rate: type: optional - docs: The journal entry's exchange rate. + docs: The invoice's exchange rate. validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - company: - type: optional - docs: The company the journal entry belongs to. + total_discount: + type: optional + docs: The total discounts applied to the total cost. + sub_total: + type: optional + docs: The total amount being paid before taxes. + payment_term: + type: optional + docs: The payment term that applies to this transaction. + total_tax_amount: + type: optional + docs: The total amount being paid in taxes. inclusive_of_tax: type: optional docs: >- If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. - lines: - type: optional> + total_amount: + type: optional + docs: The invoice's total amount. + balance: + type: optional + docs: The invoice's remaining balance. + payments: + type: optional>> + docs: Array of `Payment` object IDs. + tracking_categories: optional>> + line_items: optional> + purchase_orders: optional>> + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + remote_fields: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + InvoiceResponse: + properties: + model: Invoice + warnings: list + errors: list + logs: optional> + source: + openapi: openapi/openapi.yml + InvoiceStatusEnum: + enum: + - PAID + - DRAFT + - SUBMITTED + - PARTIALLY_PAID + - OPEN + - VOID + docs: |- + * `PAID` - PAID + * `DRAFT` - DRAFT + * `SUBMITTED` - SUBMITTED + * `PARTIALLY_PAID` - PARTIALLY_PAID + * `OPEN` - OPEN + * `VOID` - VOID + source: + openapi: openapi/openapi.yml + InvoiceTypeEnum: + enum: + - ACCOUNTS_RECEIVABLE + - ACCOUNTS_PAYABLE + docs: |- + * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE + * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE + source: + openapi: openapi/openapi.yml + IssueStatus: + discriminated: false + docs: |- + Status of the issue. Options: ('ONGOING', 'RESOLVED') + + * `ONGOING` - ONGOING + * `RESOLVED` - RESOLVED + union: + - IssueStatusEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + Issue: + properties: + id: + type: optional + validation: + format: uuid access: read-only - journal_number: + status: + type: optional + docs: |- + Status of the issue. Options: ('ONGOING', 'RESOLVED') + + * `ONGOING` - ONGOING + * `RESOLVED` - RESOLVED + error_description: string + end_user: + type: optional> + access: read-only + first_incident_time: optional + last_incident_time: optional + is_muted: + type: optional + access: read-only + error_details: + type: optional> + access: read-only + source: + openapi: openapi/openapi.yml + IssueStatusEnum: + enum: + - ONGOING + - RESOLVED + docs: |- + * `ONGOING` - ONGOING + * `RESOLVED` - RESOLVED + source: + openapi: openapi/openapi.yml + ItemStatus: + discriminated: false + docs: |- + The item's status. + + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + union: + - Status7D1Enum + - string + source: + openapi: openapi/openapi.yml + inline: true + ItemType: + discriminated: false + docs: |- + The item's type. + + * `INVENTORY` - INVENTORY + * `NON_INVENTORY` - NON_INVENTORY + * `SERVICE` - SERVICE + * `UNKNOWN` - UNKNOWN + union: + - Type2BbEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + ItemPurchaseAccount: + discriminated: false + docs: References the default account used to record a purchase of the item. + union: + - type: string + validation: + format: uuid + - Account + source: + openapi: openapi/openapi.yml + inline: true + ItemSalesAccount: + discriminated: false + docs: References the default account used to record a sale. + union: + - type: string + validation: + format: uuid + - Account + source: + openapi: openapi/openapi.yml + inline: true + ItemCompany: + discriminated: false + docs: The company the item belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + ItemPurchaseTaxRate: + discriminated: false + docs: The default purchase tax rate for this item. + union: + - type: string + validation: + format: uuid + - TaxRate + source: + openapi: openapi/openapi.yml + inline: true + ItemSalesTaxRate: + discriminated: false + docs: The default sales tax rate for this item. + union: + - type: string + validation: + format: uuid + - TaxRate + source: + openapi: openapi/openapi.yml + inline: true + Item: + docs: |- + # The Item Object + ### Description + The `Item` object refers to the goods involved in a transaction. + + ### Usage Example + Fetch from the `LIST Items` endpoint and view a company's items. + properties: + id: type: optional - docs: Reference number for identifying journal entries. validation: - maxLength: 70 - tracking_categories: optional>> + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + name: + type: optional + docs: The item's name. + status: + type: optional + docs: |- + The item's status. + + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + type: + type: optional + docs: |- + The item's type. + + * `INVENTORY` - INVENTORY + * `NON_INVENTORY` - NON_INVENTORY + * `SERVICE` - SERVICE + * `UNKNOWN` - UNKNOWN + unit_price: + type: optional + docs: The item's unit price. + purchase_price: + type: optional + docs: The price at which the item is purchased from a vendor. + purchase_account: + type: optional + docs: References the default account used to record a purchase of the item. + sales_account: + type: optional + docs: References the default account used to record a sale. + company: + type: optional + docs: The company the item belongs to. + purchase_tax_rate: + type: optional + docs: The default purchase tax rate for this item. + sales_tax_rate: + type: optional + docs: The default sales tax rate for this item. + remote_updated_at: + type: optional + docs: When the third party's item note was updated. remote_was_deleted: type: optional docs: >- @@ -36807,34 +32158,204 @@ types: [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). access: read-only - posting_status: - type: optional - docs: |- - The journal's posting status. - - * `UNPOSTED` - UNPOSTED - * `POSTED` - POSTED - accounting_period: - type: optional - docs: The accounting period that the JournalEntry was generated in. - remote_created_at: - type: optional - docs: When the third party's journal entry was created. - remote_updated_at: - type: optional - docs: When the third party's journal entry was updated. field_mappings: type: optional> access: read-only remote_data: type: optional> access: read-only - remote_fields: - type: optional> - access: read-only source: openapi: openapi/openapi.yml - JournalEntryRequestPaymentsItem: + ItemFormatEnum: + enum: + - string + - number + - date + - datetime + - bool + - list + docs: |- + * `string` - uuid + * `number` - url + * `date` - email + * `datetime` - phone + * `bool` - currency + * `list` - decimal + source: + openapi: openapi/openapi.yml + ItemRequestRequestStatus: + discriminated: false + docs: |- + The item's status. + + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + union: + - Status7D1Enum + - string + source: + openapi: openapi/openapi.yml + inline: true + ItemRequestRequestType: + discriminated: false + docs: |- + The item's type. + + * `INVENTORY` - INVENTORY + * `NON_INVENTORY` - NON_INVENTORY + * `SERVICE` - SERVICE + * `UNKNOWN` - UNKNOWN + union: + - Type2BbEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + ItemRequestRequestPurchaseAccount: + discriminated: false + docs: References the default account used to record a purchase of the item. + union: + - type: string + validation: + format: uuid + - Account + source: + openapi: openapi/openapi.yml + inline: true + ItemRequestRequestSalesAccount: + discriminated: false + docs: References the default account used to record a sale. + union: + - type: string + validation: + format: uuid + - Account + source: + openapi: openapi/openapi.yml + inline: true + ItemRequestRequestCompany: + discriminated: false + docs: The company the item belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + ItemRequestRequestPurchaseTaxRate: + discriminated: false + docs: The default purchase tax rate for this item. + union: + - type: string + validation: + format: uuid + - TaxRate + source: + openapi: openapi/openapi.yml + inline: true + ItemRequestRequestSalesTaxRate: + discriminated: false + docs: The default sales tax rate for this item. + union: + - type: string + validation: + format: uuid + - TaxRate + source: + openapi: openapi/openapi.yml + inline: true + ItemRequestRequest: + docs: |- + # The Item Object + ### Description + The `Item` object refers to the goods involved in a transaction. + + ### Usage Example + Fetch from the `LIST Items` endpoint and view a company's items. + properties: + name: + type: optional + docs: The item's name. + status: + type: optional + docs: |- + The item's status. + + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + type: + type: optional + docs: |- + The item's type. + + * `INVENTORY` - INVENTORY + * `NON_INVENTORY` - NON_INVENTORY + * `SERVICE` - SERVICE + * `UNKNOWN` - UNKNOWN + unit_price: + type: optional + docs: The item's unit price. + purchase_price: + type: optional + docs: The price at which the item is purchased from a vendor. + purchase_account: + type: optional + docs: References the default account used to record a purchase of the item. + sales_account: + type: optional + docs: References the default account used to record a sale. + company: + type: optional + docs: The company the item belongs to. + purchase_tax_rate: + type: optional + docs: The default purchase tax rate for this item. + sales_tax_rate: + type: optional + docs: The default sales tax rate for this item. + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + ItemResponse: + properties: + model: Item + warnings: list + errors: list + logs: optional> + source: + openapi: openapi/openapi.yml + ItemSchema: + properties: + item_type: optional + item_format: optional + item_choices: optional> + source: + openapi: openapi/openapi.yml + ItemTypeEnum: + enum: + - string + - number + - date + - datetime + - bool + - list + docs: |- + * `string` - string + * `number` - number + * `date` - date + * `datetime` - datetime + * `bool` - bool + * `list` - list + source: + openapi: openapi/openapi.yml + JournalEntryPaymentsItem: discriminated: false union: - type: string @@ -36844,7 +32365,17 @@ types: source: openapi: openapi/openapi.yml inline: true - JournalEntryRequestCurrency: + JournalEntryAppliedPaymentsItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - PaymentLineItem + source: + openapi: openapi/openapi.yml + inline: true + JournalEntryCurrency: discriminated: false docs: >- The journal's currency. @@ -37468,7 +32999,7 @@ types: source: openapi: openapi/openapi.yml inline: true - JournalEntryRequestCompany: + JournalEntryCompany: discriminated: false docs: The company the journal entry belongs to. union: @@ -37479,7 +33010,7 @@ types: source: openapi: openapi/openapi.yml inline: true - JournalEntryRequestTrackingCategoriesItem: + JournalEntryTrackingCategoriesItem: discriminated: false union: - type: string @@ -37489,7 +33020,7 @@ types: source: openapi: openapi/openapi.yml inline: true - JournalEntryRequestPostingStatus: + JournalEntryPostingStatus: discriminated: false docs: |- The journal's posting status. @@ -37502,15 +33033,35 @@ types: source: openapi: openapi/openapi.yml inline: true - JournalEntryRequest: + JournalEntryAccountingPeriod: + discriminated: false + docs: The accounting period that the JournalEntry was generated in. + union: + - type: string + validation: + format: uuid + - AccountingPeriod + source: + openapi: openapi/openapi.yml + inline: true + JournalEntry: docs: >- # The JournalEntry Object ### Description - The `JournalEntry` object is used to get a record of all manually created - entries made in a company’s general ledger. The journal line items for - each journal entry should sum to zero. + A `JournalEntry` is a record of a transaction or event that is entered + into a company's accounting system. + + + The `JournalEntry` common model contains records that are automatically + created as a result of a certain type of transaction, like an Invoice, and + records that are manually created against a company’s ledger. + + + The lines of a given `JournalEntry` object should always sum to 0. A + positive `net_amount` means the line represents a debit and a negative + net_amount represents a credit. ### Usage Example @@ -37518,17 +33069,38 @@ types: Fetch from the `GET JournalEntry` endpoint and view a company's journey entry. properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only transaction_date: type: optional docs: The journal entry's transaction date. payments: - type: optional>> + type: optional>> docs: Array of `Payment` object IDs. + applied_payments: + type: optional>> + docs: >- + A list of the Payment Applied to Lines common models related to a + given Invoice, Credit Note, or Journal Entry. memo: type: optional docs: The journal entry's private note. currency: - type: optional + type: optional docs: >- The journal's currency. @@ -38151,80 +33723,72 @@ types: validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ company: - type: optional + type: optional docs: The company the journal entry belongs to. - tracking_categories: optional>> inclusive_of_tax: type: optional docs: >- If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. - lines: optional> + lines: + type: optional> + access: read-only journal_number: type: optional docs: Reference number for identifying journal entries. validation: maxLength: 70 + tracking_categories: optional>> + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only posting_status: - type: optional + type: optional docs: |- The journal's posting status. * `UNPOSTED` - UNPOSTED * `POSTED` - POSTED - integration_params: - type: optional> - access: write-only - linked_account_params: + accounting_period: + type: optional + docs: The accounting period that the JournalEntry was generated in. + remote_created_at: + type: optional + docs: When the third party's journal entry was created. + remote_updated_at: + type: optional + docs: When the third party's journal entry was updated. + field_mappings: type: optional> - access: write-only + access: read-only + remote_data: + type: optional> + access: read-only remote_fields: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - JournalEntryResponse: - properties: - model: JournalEntry - warnings: list - errors: list - logs: optional> - source: - openapi: openapi/openapi.yml - JournalLineAccount: - discriminated: false - union: - - type: string - validation: - format: uuid - - Account - source: - openapi: openapi/openapi.yml - inline: true - JournalLineTrackingCategory: - discriminated: false - union: - - type: string - validation: - format: uuid - - TrackingCategory + type: optional> + access: read-only source: openapi: openapi/openapi.yml - inline: true - JournalLineTrackingCategoriesItem: + JournalEntryRequestPaymentsItem: discriminated: false union: - type: string validation: format: uuid - - TrackingCategory + - Payment source: openapi: openapi/openapi.yml inline: true - JournalLineCurrency: + JournalEntryRequestCurrency: discriminated: false docs: >- - The journal line item's currency. + The journal's currency. * `XUA` - ADB Unit of Account @@ -38845,61 +34409,69 @@ types: source: openapi: openapi/openapi.yml inline: true - JournalLineProject: + JournalEntryRequestCompany: discriminated: false + docs: The company the journal entry belongs to. union: - type: string validation: format: uuid - - Project + - CompanyInfo source: openapi: openapi/openapi.yml inline: true - JournalLine: + JournalEntryRequestTrackingCategoriesItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - TrackingCategory + source: + openapi: openapi/openapi.yml + inline: true + JournalEntryRequestPostingStatus: + discriminated: false + docs: |- + The journal's posting status. + + * `UNPOSTED` - UNPOSTED + * `POSTED` - POSTED + union: + - PostingStatusEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + JournalEntryRequest: docs: >- - # The JournalLine Object + # The JournalEntry Object ### Description - The `JournalLine` object is used to represent a journal entry's line - items. + The `JournalEntry` object is used to get a record of all manually created + entries made in a company’s general ledger. The journal line items for + each journal entry should sum to zero. ### Usage Example - Fetch from the `GET JournalEntry` endpoint and view the journal entry's - line items. + Fetch from the `GET JournalEntry` endpoint and view a company's journey + entry. properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: + transaction_date: type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - account: optional - net_amount: - type: optional - docs: The value of the line item including taxes and other fees. - tracking_category: - type: optional - availability: deprecated - tracking_categories: - type: optional>> - docs: The journal line item's associated tracking categories. + docs: The journal entry's transaction date. + payments: + type: optional>> + docs: Array of `Payment` object IDs. + memo: + type: optional + docs: The journal entry's private note. currency: - type: optional + type: optional docs: >- - The journal line item's currency. + The journal's currency. * `XUA` - ADB Unit of Account @@ -39514,48 +35086,53 @@ types: * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) - company: - type: optional - docs: The company the journal entry belongs to. - validation: - format: uuid - employee: - type: optional - validation: - format: uuid - project: optional - contact: - type: optional - validation: - format: uuid - tax_rate: - type: optional - docs: The tax rate that applies to this line item. - validation: - format: uuid - description: - type: optional - docs: The line's description. exchange_rate: type: optional - docs: The journal line item's exchange rate. + docs: The journal entry's exchange rate. validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - remote_was_deleted: + company: + type: optional + docs: The company the journal entry belongs to. + tracking_categories: optional>> + inclusive_of_tax: type: optional docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only + If the transaction is inclusive or exclusive of tax. `True` if + inclusive, `False` if exclusive. + lines: optional> + journal_number: + type: optional + docs: Reference number for identifying journal entries. + validation: + maxLength: 70 + posting_status: + type: optional + docs: |- + The journal's posting status. + + * `UNPOSTED` - UNPOSTED + * `POSTED` - POSTED + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only remote_fields: - type: optional> - access: read-only + type: optional> + access: write-only source: openapi: openapi/openapi.yml - JournalLineRequestAccount: + JournalEntryResponse: + properties: + model: JournalEntry + warnings: list + errors: list + logs: optional> + source: + openapi: openapi/openapi.yml + JournalLineAccount: discriminated: false union: - type: string @@ -39565,7 +35142,7 @@ types: source: openapi: openapi/openapi.yml inline: true - JournalLineRequestTrackingCategory: + JournalLineTrackingCategory: discriminated: false union: - type: string @@ -39575,7 +35152,7 @@ types: source: openapi: openapi/openapi.yml inline: true - JournalLineRequestTrackingCategoriesItem: + JournalLineTrackingCategoriesItem: discriminated: false union: - type: string @@ -39585,7 +35162,7 @@ types: source: openapi: openapi/openapi.yml inline: true - JournalLineRequestCurrency: + JournalLineCurrency: discriminated: false docs: >- The journal line item's currency. @@ -40209,7 +35786,7 @@ types: source: openapi: openapi/openapi.yml inline: true - JournalLineRequestProject: + JournalLineProject: discriminated: false union: - type: string @@ -40219,7 +35796,7 @@ types: source: openapi: openapi/openapi.yml inline: true - JournalLineRequest: + JournalLine: docs: >- # The JournalLine Object @@ -40234,21 +35811,34 @@ types: Fetch from the `GET JournalEntry` endpoint and view the journal entry's line items. properties: + id: + type: optional + validation: + format: uuid + access: read-only remote_id: type: optional docs: The third-party API ID of the matching object. - account: optional + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + account: optional net_amount: type: optional docs: The value of the line item including taxes and other fees. tracking_category: - type: optional + type: optional availability: deprecated tracking_categories: - type: optional>> + type: optional>> docs: The journal line item's associated tracking categories. currency: - type: optional + type: optional docs: >- The journal line item's currency. @@ -40537,905 +36127,409 @@ types: * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar - - * `KGS` - Kyrgystani Som - - * `LAK` - Laotian Kip - - * `LVL` - Latvian Lats - - * `LVR` - Latvian Ruble - - * `LBP` - Lebanese Pound - - * `LSL` - Lesotho Loti - - * `LRD` - Liberian Dollar - - * `LYD` - Libyan Dinar - - * `LTL` - Lithuanian Litas - - * `LTT` - Lithuanian Talonas - - * `LUL` - Luxembourg Financial Franc - - * `LUC` - Luxembourgian Convertible Franc - - * `LUF` - Luxembourgian Franc - - * `MOP` - Macanese Pataca - - * `MKD` - Macedonian Denar - - * `MKN` - Macedonian Denar (1992–1993) - - * `MGA` - Malagasy Ariary - - * `MGF` - Malagasy Franc - - * `MWK` - Malawian Kwacha - - * `MYR` - Malaysian Ringgit - - * `MVR` - Maldivian Rufiyaa - - * `MVP` - Maldivian Rupee (1947–1981) - - * `MLF` - Malian Franc - - * `MTL` - Maltese Lira - - * `MTP` - Maltese Pound - - * `MRU` - Mauritanian Ouguiya - - * `MRO` - Mauritanian Ouguiya (1973–2017) - - * `MUR` - Mauritian Rupee - - * `MXV` - Mexican Investment Unit - - * `MXN` - Mexican Peso - - * `MXP` - Mexican Silver Peso (1861–1992) - - * `MDC` - Moldovan Cupon - - * `MDL` - Moldovan Leu - - * `MCF` - Monegasque Franc - - * `MNT` - Mongolian Tugrik - - * `MAD` - Moroccan Dirham - - * `MAF` - Moroccan Franc - - * `MZE` - Mozambican Escudo - - * `MZN` - Mozambican Metical - - * `MZM` - Mozambican Metical (1980–2006) - - * `MMK` - Myanmar Kyat - - * `NAD` - Namibian Dollar - - * `NPR` - Nepalese Rupee - - * `ANG` - Netherlands Antillean Guilder - - * `TWD` - New Taiwan Dollar - - * `NZD` - New Zealand Dollar - - * `NIO` - Nicaraguan Córdoba - - * `NIC` - Nicaraguan Córdoba (1988–1991) - - * `NGN` - Nigerian Naira - - * `KPW` - North Korean Won - - * `NOK` - Norwegian Krone - - * `OMR` - Omani Rial - - * `PKR` - Pakistani Rupee - - * `XPD` - Palladium - - * `PAB` - Panamanian Balboa - - * `PGK` - Papua New Guinean Kina - - * `PYG` - Paraguayan Guarani - - * `PEI` - Peruvian Inti - - * `PEN` - Peruvian Sol - - * `PES` - Peruvian Sol (1863–1965) - - * `PHP` - Philippine Peso - - * `XPT` - Platinum - - * `PLN` - Polish Zloty - - * `PLZ` - Polish Zloty (1950–1995) - - * `PTE` - Portuguese Escudo - - * `GWE` - Portuguese Guinea Escudo - - * `QAR` - Qatari Rial - - * `XRE` - RINET Funds - - * `RHD` - Rhodesian Dollar - - * `RON` - Romanian Leu - - * `ROL` - Romanian Leu (1952–2006) - - * `RUB` - Russian Ruble - - * `RUR` - Russian Ruble (1991–1998) - - * `RWF` - Rwandan Franc - - * `SVC` - Salvadoran Colón - - * `WST` - Samoan Tala - - * `SAR` - Saudi Riyal - - * `RSD` - Serbian Dinar - - * `CSD` - Serbian Dinar (2002–2006) - - * `SCR` - Seychellois Rupee - - * `SLL` - Sierra Leonean Leone - - * `XAG` - Silver - - * `SGD` - Singapore Dollar - - * `SKK` - Slovak Koruna - - * `SIT` - Slovenian Tolar - - * `SBD` - Solomon Islands Dollar - - * `SOS` - Somali Shilling - - * `ZAR` - South African Rand - - * `ZAL` - South African Rand (financial) - - * `KRH` - South Korean Hwan (1953–1962) - - * `KRW` - South Korean Won - - * `KRO` - South Korean Won (1945–1953) - - * `SSP` - South Sudanese Pound - - * `SUR` - Soviet Rouble - - * `ESP` - Spanish Peseta - - * `ESA` - Spanish Peseta (A account) - - * `ESB` - Spanish Peseta (convertible account) - - * `XDR` - Special Drawing Rights - - * `LKR` - Sri Lankan Rupee - - * `SHP` - St. Helena Pound - - * `XSU` - Sucre - - * `SDD` - Sudanese Dinar (1992–2007) - - * `SDG` - Sudanese Pound - - * `SDP` - Sudanese Pound (1957–1998) - - * `SRD` - Surinamese Dollar - - * `SRG` - Surinamese Guilder - - * `SZL` - Swazi Lilangeni - - * `SEK` - Swedish Krona - - * `CHF` - Swiss Franc - - * `SYP` - Syrian Pound - - * `STN` - São Tomé & Príncipe Dobra - - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - - * `TVD` - TVD - - * `TJR` - Tajikistani Ruble - - * `TJS` - Tajikistani Somoni - - * `TZS` - Tanzanian Shilling - - * `XTS` - Testing Currency Code - - * `THB` - Thai Baht - - * `XXX` - The codes assigned for transactions where no currency is - involved - - * `TPE` - Timorese Escudo - - * `TOP` - Tongan Paʻanga - - * `TTD` - Trinidad & Tobago Dollar - - * `TND` - Tunisian Dinar - - * `TRY` - Turkish Lira - - * `TRL` - Turkish Lira (1922–2005) - - * `TMT` - Turkmenistani Manat - - * `TMM` - Turkmenistani Manat (1993–2009) - - * `USD` - US Dollar - - * `USN` - US Dollar (Next day) + * `KWD` - Kuwaiti Dinar - * `USS` - US Dollar (Same day) + * `KGS` - Kyrgystani Som - * `UGX` - Ugandan Shilling + * `LAK` - Laotian Kip - * `UGS` - Ugandan Shilling (1966–1987) + * `LVL` - Latvian Lats - * `UAH` - Ukrainian Hryvnia + * `LVR` - Latvian Ruble - * `UAK` - Ukrainian Karbovanets + * `LBP` - Lebanese Pound - * `AED` - United Arab Emirates Dirham + * `LSL` - Lesotho Loti - * `UYW` - Uruguayan Nominal Wage Index Unit + * `LRD` - Liberian Dollar - * `UYU` - Uruguayan Peso + * `LYD` - Libyan Dinar - * `UYP` - Uruguayan Peso (1975–1993) + * `LTL` - Lithuanian Litas - * `UYI` - Uruguayan Peso (Indexed Units) + * `LTT` - Lithuanian Talonas - * `UZS` - Uzbekistani Som + * `LUL` - Luxembourg Financial Franc - * `VUV` - Vanuatu Vatu + * `LUC` - Luxembourgian Convertible Franc - * `VES` - Venezuelan Bolívar + * `LUF` - Luxembourgian Franc - * `VEB` - Venezuelan Bolívar (1871–2008) + * `MOP` - Macanese Pataca - * `VEF` - Venezuelan Bolívar (2008–2018) + * `MKD` - Macedonian Denar - * `VND` - Vietnamese Dong + * `MKN` - Macedonian Denar (1992–1993) - * `VNN` - Vietnamese Dong (1978–1985) + * `MGA` - Malagasy Ariary - * `CHE` - WIR Euro + * `MGF` - Malagasy Franc - * `CHW` - WIR Franc + * `MWK` - Malawian Kwacha - * `XOF` - West African CFA Franc + * `MYR` - Malaysian Ringgit - * `YDD` - Yemeni Dinar + * `MVR` - Maldivian Rufiyaa - * `YER` - Yemeni Rial + * `MVP` - Maldivian Rupee (1947–1981) - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `MLF` - Malian Franc - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + * `MTL` - Maltese Lira - * `YUM` - Yugoslavian New Dinar (1994–2002) + * `MTP` - Maltese Pound - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + * `MRU` - Mauritanian Ouguiya - * `ZWN` - ZWN + * `MRO` - Mauritanian Ouguiya (1973–2017) - * `ZRN` - Zairean New Zaire (1993–1998) + * `MUR` - Mauritian Rupee - * `ZRZ` - Zairean Zaire (1971–1993) + * `MXV` - Mexican Investment Unit - * `ZMW` - Zambian Kwacha + * `MXN` - Mexican Peso - * `ZMK` - Zambian Kwacha (1968–2012) + * `MXP` - Mexican Silver Peso (1861–1992) - * `ZWD` - Zimbabwean Dollar (1980–2008) + * `MDC` - Moldovan Cupon - * `ZWR` - Zimbabwean Dollar (2008) + * `MDL` - Moldovan Leu - * `ZWL` - Zimbabwean Dollar (2009) - company: - type: optional - docs: The company the journal entry belongs to. - validation: - format: uuid - employee: - type: optional - validation: - format: uuid - project: optional - contact: - type: optional - validation: - format: uuid - tax_rate: - type: optional - docs: The tax rate that applies to this line item. - validation: - format: uuid - description: - type: optional - docs: The line's description. - exchange_rate: - type: optional - docs: The journal line item's exchange rate. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only - remote_fields: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - LanguageEnum: - enum: - - en - - de - docs: |- - * `en` - en - * `de` - de - source: - openapi: openapi/openapi.yml - LastSyncResultEnum: - enum: - - SYNCING - - DONE - - FAILED - - DISABLED - - PAUSED - - PARTIALLY_SYNCED - docs: |- - * `SYNCING` - SYNCING - * `DONE` - DONE - * `FAILED` - FAILED - * `DISABLED` - DISABLED - * `PAUSED` - PAUSED - * `PARTIALLY_SYNCED` - PARTIALLY_SYNCED - source: - openapi: openapi/openapi.yml - LinkToken: - properties: - link_token: string - integration_name: optional - magic_link_url: optional - source: - openapi: openapi/openapi.yml - LinkedAccountStatus: - properties: - linked_account_status: string - can_make_request: boolean - source: - openapi: openapi/openapi.yml - MetaResponse: - properties: - request_schema: map - remote_field_classes: optional> - status: optional - has_conditional_params: boolean - has_required_linked_account_params: boolean - source: - openapi: openapi/openapi.yml - MethodEnum: - enum: - - GET - - OPTIONS - - HEAD - - POST - - PUT - - PATCH - - DELETE - docs: |- - * `GET` - GET - * `OPTIONS` - OPTIONS - * `HEAD` - HEAD - * `POST` - POST - * `PUT` - PUT - * `PATCH` - PATCH - * `DELETE` - DELETE - source: - openapi: openapi/openapi.yml - MethodTypeEnum: - enum: - - CREDIT_CARD - - DEBIT_CARD - - ACH - - CASH - - CHECK - docs: |- - * `CREDIT_CARD` - CREDIT_CARD - * `DEBIT_CARD` - DEBIT_CARD - * `ACH` - ACH - * `CASH` - CASH - * `CHECK` - CHECK - source: - openapi: openapi/openapi.yml - ModelOperation: - docs: >- - # The ModelOperation Object + * `MCF` - Monegasque Franc - ### Description + * `MNT` - Mongolian Tugrik - The `ModelOperation` object is used to represent the operations that are - currently supported for a given model. + * `MAD` - Moroccan Dirham + * `MAF` - Moroccan Franc - ### Usage Example + * `MZE` - Mozambican Escudo - View what operations are supported for the `Candidate` endpoint. - properties: - model_name: string - available_operations: list - required_post_parameters: list - supported_fields: list - source: - openapi: openapi/openapi.yml - ModelPermissionDeserializer: - properties: - is_enabled: optional - source: - openapi: openapi/openapi.yml - ModelPermissionDeserializerRequest: - properties: - is_enabled: optional - source: - openapi: openapi/openapi.yml - MultipartFormFieldRequestEncoding: - discriminated: false - docs: |- - The encoding of the value of `data`. Defaults to `RAW` if not defined. + * `MZN` - Mozambican Metical - * `RAW` - RAW - * `BASE64` - BASE64 - * `GZIP_BASE64` - GZIP_BASE64 - union: - - EncodingEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - MultipartFormFieldRequest: - docs: >- - # The MultipartFormField Object + * `MZM` - Mozambican Metical (1980–2006) - ### Description + * `MMK` - Myanmar Kyat - The `MultipartFormField` object is used to represent fields in an HTTP - request using `multipart/form-data`. + * `NAD` - Namibian Dollar + * `NPR` - Nepalese Rupee - ### Usage Example + * `ANG` - Netherlands Antillean Guilder - Create a `MultipartFormField` to define a multipart form entry. - properties: - name: - type: string - docs: The name of the form field - validation: - minLength: 1 - data: - type: string - docs: The data for the form field. - validation: - minLength: 1 - encoding: - type: optional - docs: |- - The encoding of the value of `data`. Defaults to `RAW` if not defined. + * `TWD` - New Taiwan Dollar - * `RAW` - RAW - * `BASE64` - BASE64 - * `GZIP_BASE64` - GZIP_BASE64 - file_name: - type: optional - docs: The file name of the form field, if the field is for a file. - validation: - minLength: 1 - content_type: - type: optional - docs: The MIME type of the file, if the field is for a file. - validation: - minLength: 1 - source: - openapi: openapi/openapi.yml - PaginatedAccountDetailsAndActionsList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedAccountList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedAccountingAttachmentList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedAccountingPeriodList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedAuditLogEventList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedBalanceSheetList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedBankFeedAccountList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedBankFeedTransactionList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedCashFlowStatementList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedCompanyInfoList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedContactList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedCreditNoteList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedEmployeeList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedExpenseList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedExpenseReportLineList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedExpenseReportList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedGeneralLedgerTransactionList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedIncomeStatementList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedInvoiceList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedIssueList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedItemList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedJournalEntryList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedPaymentList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedPaymentMethodList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedPaymentTermList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedProjectList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedPurchaseOrderList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedRemoteFieldClassList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedSyncStatusList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedTaxRateList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedTrackingCategoryList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedTransactionList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PaginatedVendorCreditList: - properties: - next: optional - previous: optional - results: optional> - source: - openapi: openapi/openapi.yml - PatchedItemRequestRequestStatus: - discriminated: false - docs: |- - The item's status. + * `NZD` - New Zealand Dollar - * `ACTIVE` - ACTIVE - * `ARCHIVED` - ARCHIVED - union: - - Status7D1Enum - - string - source: - openapi: openapi/openapi.yml - inline: true - PatchedItemRequestRequestType: - discriminated: false - docs: |- - The item's type. + * `NIO` - Nicaraguan Córdoba - * `INVENTORY` - INVENTORY - * `NON_INVENTORY` - NON_INVENTORY - * `SERVICE` - SERVICE - * `UNKNOWN` - UNKNOWN - union: - - Type2BbEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - PatchedItemRequestRequest: - docs: |- - # The Item Object - ### Description - The `Item` object refers to the goods involved in a transaction. + * `NIC` - Nicaraguan Córdoba (1988–1991) - ### Usage Example - Fetch from the `LIST Items` endpoint and view a company's items. - properties: - name: - type: optional - docs: The item's name. - status: - type: optional - docs: |- - The item's status. + * `NGN` - Nigerian Naira - * `ACTIVE` - ACTIVE - * `ARCHIVED` - ARCHIVED - type: - type: optional - docs: |- - The item's type. + * `KPW` - North Korean Won - * `INVENTORY` - INVENTORY - * `NON_INVENTORY` - NON_INVENTORY - * `SERVICE` - SERVICE - * `UNKNOWN` - UNKNOWN - unit_price: - type: optional - docs: The item's unit price. - purchase_price: - type: optional - docs: The price at which the item is purchased from a vendor. - purchase_account: + * `NOK` - Norwegian Krone + + * `OMR` - Omani Rial + + * `PKR` - Pakistani Rupee + + * `XPD` - Palladium + + * `PAB` - Panamanian Balboa + + * `PGK` - Papua New Guinean Kina + + * `PYG` - Paraguayan Guarani + + * `PEI` - Peruvian Inti + + * `PEN` - Peruvian Sol + + * `PES` - Peruvian Sol (1863–1965) + + * `PHP` - Philippine Peso + + * `XPT` - Platinum + + * `PLN` - Polish Zloty + + * `PLZ` - Polish Zloty (1950–1995) + + * `PTE` - Portuguese Escudo + + * `GWE` - Portuguese Guinea Escudo + + * `QAR` - Qatari Rial + + * `XRE` - RINET Funds + + * `RHD` - Rhodesian Dollar + + * `RON` - Romanian Leu + + * `ROL` - Romanian Leu (1952–2006) + + * `RUB` - Russian Ruble + + * `RUR` - Russian Ruble (1991–1998) + + * `RWF` - Rwandan Franc + + * `SVC` - Salvadoran Colón + + * `WST` - Samoan Tala + + * `SAR` - Saudi Riyal + + * `RSD` - Serbian Dinar + + * `CSD` - Serbian Dinar (2002–2006) + + * `SCR` - Seychellois Rupee + + * `SLL` - Sierra Leonean Leone + + * `XAG` - Silver + + * `SGD` - Singapore Dollar + + * `SKK` - Slovak Koruna + + * `SIT` - Slovenian Tolar + + * `SBD` - Solomon Islands Dollar + + * `SOS` - Somali Shilling + + * `ZAR` - South African Rand + + * `ZAL` - South African Rand (financial) + + * `KRH` - South Korean Hwan (1953–1962) + + * `KRW` - South Korean Won + + * `KRO` - South Korean Won (1945–1953) + + * `SSP` - South Sudanese Pound + + * `SUR` - Soviet Rouble + + * `ESP` - Spanish Peseta + + * `ESA` - Spanish Peseta (A account) + + * `ESB` - Spanish Peseta (convertible account) + + * `XDR` - Special Drawing Rights + + * `LKR` - Sri Lankan Rupee + + * `SHP` - St. Helena Pound + + * `XSU` - Sucre + + * `SDD` - Sudanese Dinar (1992–2007) + + * `SDG` - Sudanese Pound + + * `SDP` - Sudanese Pound (1957–1998) + + * `SRD` - Surinamese Dollar + + * `SRG` - Surinamese Guilder + + * `SZL` - Swazi Lilangeni + + * `SEK` - Swedish Krona + + * `CHF` - Swiss Franc + + * `SYP` - Syrian Pound + + * `STN` - São Tomé & Príncipe Dobra + + * `STD` - São Tomé & Príncipe Dobra (1977–2017) + + * `TVD` - TVD + + * `TJR` - Tajikistani Ruble + + * `TJS` - Tajikistani Somoni + + * `TZS` - Tanzanian Shilling + + * `XTS` - Testing Currency Code + + * `THB` - Thai Baht + + * `XXX` - The codes assigned for transactions where no currency is + involved + + * `TPE` - Timorese Escudo + + * `TOP` - Tongan Paʻanga + + * `TTD` - Trinidad & Tobago Dollar + + * `TND` - Tunisian Dinar + + * `TRY` - Turkish Lira + + * `TRL` - Turkish Lira (1922–2005) + + * `TMT` - Turkmenistani Manat + + * `TMM` - Turkmenistani Manat (1993–2009) + + * `USD` - US Dollar + + * `USN` - US Dollar (Next day) + + * `USS` - US Dollar (Same day) + + * `UGX` - Ugandan Shilling + + * `UGS` - Ugandan Shilling (1966–1987) + + * `UAH` - Ukrainian Hryvnia + + * `UAK` - Ukrainian Karbovanets + + * `AED` - United Arab Emirates Dirham + + * `UYW` - Uruguayan Nominal Wage Index Unit + + * `UYU` - Uruguayan Peso + + * `UYP` - Uruguayan Peso (1975–1993) + + * `UYI` - Uruguayan Peso (Indexed Units) + + * `UZS` - Uzbekistani Som + + * `VUV` - Vanuatu Vatu + + * `VES` - Venezuelan Bolívar + + * `VEB` - Venezuelan Bolívar (1871–2008) + + * `VEF` - Venezuelan Bolívar (2008–2018) + + * `VND` - Vietnamese Dong + + * `VNN` - Vietnamese Dong (1978–1985) + + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) + company: type: optional - docs: References the default account used to record a purchase of the item. + docs: The company the journal entry belongs to. validation: format: uuid - sales_account: + employee: type: optional - docs: References the default account used to record a sale. validation: format: uuid - company: + project: optional + contact: type: optional - docs: The company the item belongs to. validation: format: uuid - purchase_tax_rate: + tax_rate: type: optional - docs: The default purchase tax rate for this item. + docs: The tax rate that applies to this line item. validation: format: uuid - sales_tax_rate: + description: type: optional - docs: The default sales tax rate for this item. + docs: The line's description. + exchange_rate: + type: optional + docs: The journal line item's exchange rate. validation: - format: uuid - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + remote_fields: + type: optional> + access: read-only source: openapi: openapi/openapi.yml - PatchedPaymentRequestContact: + JournalLineRequestAccount: discriminated: false - docs: The supplier, or customer involved in the payment. union: - type: string validation: format: uuid - - Contact + - Account source: openapi: openapi/openapi.yml inline: true - PatchedPaymentRequestAccount: + JournalLineRequestTrackingCategory: discriminated: false - docs: The supplier’s or customer’s account in which the payment is made. union: - type: string validation: format: uuid - - Account + - TrackingCategory source: openapi: openapi/openapi.yml inline: true - PatchedPaymentRequestPaymentMethod: + JournalLineRequestTrackingCategoriesItem: discriminated: false - docs: The method which this payment was made by. union: - type: string validation: format: uuid - - PaymentMethod + - TrackingCategory source: openapi: openapi/openapi.yml inline: true - PatchedPaymentRequestCurrency: + JournalLineRequestCurrency: discriminated: false docs: >- - The payment's currency. + The journal line item's currency. * `XUA` - ADB Unit of Account @@ -42056,91 +37150,48 @@ types: source: openapi: openapi/openapi.yml inline: true - PatchedPaymentRequestCompany: - discriminated: false - docs: The company the payment belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true - PatchedPaymentRequestType: - discriminated: false - docs: |- - The type of the invoice. - - * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE - * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE - union: - - PaymentTypeEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - PatchedPaymentRequestTrackingCategoriesItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - TrackingCategory - source: - openapi: openapi/openapi.yml - inline: true - PatchedPaymentRequestAccountingPeriod: - discriminated: false - docs: The accounting period that the Payment was generated in. - union: - - type: string - validation: - format: uuid - - AccountingPeriod - source: - openapi: openapi/openapi.yml - inline: true - PatchedPaymentRequestAppliedToLinesItem: + JournalLineRequestProject: discriminated: false union: - type: string validation: format: uuid - - PaymentLineItemRequest + - Project source: openapi: openapi/openapi.yml inline: true - PatchedPaymentRequest: + JournalLineRequest: docs: >- - # The Payment Object + # The JournalLine Object ### Description - The `Payment` object represents general payments made towards a specific - transaction. + The `JournalLine` object is used to represent a journal entry's line + items. ### Usage Example - Fetch from the `GET Payment` endpoint and view an invoice's payment. + Fetch from the `GET JournalEntry` endpoint and view the journal entry's + line items. properties: - transaction_date: - type: optional - docs: The payment's transaction date. - contact: - type: optional - docs: The supplier, or customer involved in the payment. - account: - type: optional - docs: The supplier’s or customer’s account in which the payment is made. - payment_method: - type: optional - docs: The method which this payment was made by. + remote_id: + type: optional + docs: The third-party API ID of the matching object. + account: optional + net_amount: + type: optional + docs: The value of the line item including taxes and other fees. + tracking_category: + type: optional + availability: deprecated + tracking_categories: + type: optional>> + docs: The journal line item's associated tracking categories. currency: - type: optional + type: optional docs: >- - The payment's currency. + The journal line item's currency. * `XUA` - ADB Unit of Account @@ -42722,78 +37773,574 @@ types: * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro + * `CHE` - WIR Euro + + * `CHW` - WIR Franc + + * `XOF` - West African CFA Franc + + * `YDD` - Yemeni Dinar + + * `YER` - Yemeni Rial + + * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + + * `YUD` - Yugoslavian Hard Dinar (1966–1990) + + * `YUM` - Yugoslavian New Dinar (1994–2002) + + * `YUR` - Yugoslavian Reformed Dinar (1992–1993) + + * `ZWN` - ZWN + + * `ZRN` - Zairean New Zaire (1993–1998) + + * `ZRZ` - Zairean Zaire (1971–1993) + + * `ZMW` - Zambian Kwacha + + * `ZMK` - Zambian Kwacha (1968–2012) + + * `ZWD` - Zimbabwean Dollar (1980–2008) + + * `ZWR` - Zimbabwean Dollar (2008) + + * `ZWL` - Zimbabwean Dollar (2009) + company: + type: optional + docs: The company the journal entry belongs to. + validation: + format: uuid + employee: + type: optional + validation: + format: uuid + project: optional + contact: + type: optional + validation: + format: uuid + tax_rate: + type: optional + docs: The tax rate that applies to this line item. + validation: + format: uuid + description: + type: optional + docs: The line's description. + exchange_rate: + type: optional + docs: The journal line item's exchange rate. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + remote_fields: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + LanguageEnum: + enum: + - en + - de + docs: |- + * `en` - en + * `de` - de + source: + openapi: openapi/openapi.yml + LastSyncResultEnum: + enum: + - SYNCING + - DONE + - FAILED + - DISABLED + - PAUSED + - PARTIALLY_SYNCED + docs: |- + * `SYNCING` - SYNCING + * `DONE` - DONE + * `FAILED` - FAILED + * `DISABLED` - DISABLED + * `PAUSED` - PAUSED + * `PARTIALLY_SYNCED` - PARTIALLY_SYNCED + source: + openapi: openapi/openapi.yml + LinkToken: + properties: + link_token: string + integration_name: optional + magic_link_url: optional + source: + openapi: openapi/openapi.yml + LinkedAccountStatus: + properties: + linked_account_status: string + can_make_request: boolean + source: + openapi: openapi/openapi.yml + MetaResponse: + properties: + request_schema: map + remote_field_classes: optional> + status: optional + has_conditional_params: boolean + has_required_linked_account_params: boolean + source: + openapi: openapi/openapi.yml + MethodEnum: + enum: + - GET + - OPTIONS + - HEAD + - POST + - PUT + - PATCH + - DELETE + docs: |- + * `GET` - GET + * `OPTIONS` - OPTIONS + * `HEAD` - HEAD + * `POST` - POST + * `PUT` - PUT + * `PATCH` - PATCH + * `DELETE` - DELETE + source: + openapi: openapi/openapi.yml + MethodTypeEnum: + enum: + - CREDIT_CARD + - DEBIT_CARD + - ACH + - CASH + - CHECK + docs: |- + * `CREDIT_CARD` - CREDIT_CARD + * `DEBIT_CARD` - DEBIT_CARD + * `ACH` - ACH + * `CASH` - CASH + * `CHECK` - CHECK + source: + openapi: openapi/openapi.yml + ModelOperation: + docs: >- + # The ModelOperation Object + + ### Description - * `CHW` - WIR Franc + The `ModelOperation` object is used to represent the operations that are + currently supported for a given model. - * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar + ### Usage Example - * `YER` - Yemeni Rial + View what operations are supported for the `Candidate` endpoint. + properties: + model_name: string + available_operations: list + required_post_parameters: list + supported_fields: list + source: + openapi: openapi/openapi.yml + ModelPermissionDeserializer: + properties: + is_enabled: optional + source: + openapi: openapi/openapi.yml + ModelPermissionDeserializerRequest: + properties: + is_enabled: optional + source: + openapi: openapi/openapi.yml + MultipartFormFieldRequestEncoding: + discriminated: false + docs: |- + The encoding of the value of `data`. Defaults to `RAW` if not defined. - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) + * `RAW` - RAW + * `BASE64` - BASE64 + * `GZIP_BASE64` - GZIP_BASE64 + union: + - EncodingEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + MultipartFormFieldRequest: + docs: >- + # The MultipartFormField Object - * `YUD` - Yugoslavian Hard Dinar (1966–1990) + ### Description - * `YUM` - Yugoslavian New Dinar (1994–2002) + The `MultipartFormField` object is used to represent fields in an HTTP + request using `multipart/form-data`. - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN + ### Usage Example - * `ZRN` - Zairean New Zaire (1993–1998) + Create a `MultipartFormField` to define a multipart form entry. + properties: + name: + type: string + docs: The name of the form field + validation: + minLength: 1 + data: + type: string + docs: The data for the form field. + validation: + minLength: 1 + encoding: + type: optional + docs: |- + The encoding of the value of `data`. Defaults to `RAW` if not defined. - * `ZRZ` - Zairean Zaire (1971–1993) + * `RAW` - RAW + * `BASE64` - BASE64 + * `GZIP_BASE64` - GZIP_BASE64 + file_name: + type: optional + docs: The file name of the form field, if the field is for a file. + validation: + minLength: 1 + content_type: + type: optional + docs: The MIME type of the file, if the field is for a file. + validation: + minLength: 1 + source: + openapi: openapi/openapi.yml + PaginatedAccountDetailsAndActionsList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedAccountList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedAccountingAttachmentList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedAccountingPeriodList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedAuditLogEventList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedBalanceSheetList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedBankFeedAccountList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedBankFeedTransactionList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedCashFlowStatementList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedCompanyInfoList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedContactList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedCreditNoteList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedEmployeeList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedExpenseList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedExpenseReportLineList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedExpenseReportList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedGeneralLedgerTransactionList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedIncomeStatementList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedInvoiceList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedIssueList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedItemList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedJournalEntryList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedPaymentList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedPaymentMethodList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedPaymentTermList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedProjectList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedPurchaseOrderList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedRemoteFieldClassList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedSyncStatusList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedTaxRateList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedTrackingCategoryList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedTransactionList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PaginatedVendorCreditList: + properties: + next: optional + previous: optional + results: optional> + source: + openapi: openapi/openapi.yml + PatchedItemRequestRequestStatus: + discriminated: false + docs: |- + The item's status. - * `ZMW` - Zambian Kwacha + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + union: + - Status7D1Enum + - string + source: + openapi: openapi/openapi.yml + inline: true + PatchedItemRequestRequestType: + discriminated: false + docs: |- + The item's type. - * `ZMK` - Zambian Kwacha (1968–2012) + * `INVENTORY` - INVENTORY + * `NON_INVENTORY` - NON_INVENTORY + * `SERVICE` - SERVICE + * `UNKNOWN` - UNKNOWN + union: + - Type2BbEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + PatchedItemRequestRequest: + docs: |- + # The Item Object + ### Description + The `Item` object refers to the goods involved in a transaction. - * `ZWD` - Zimbabwean Dollar (1980–2008) + ### Usage Example + Fetch from the `LIST Items` endpoint and view a company's items. + properties: + name: + type: optional + docs: The item's name. + status: + type: optional + docs: |- + The item's status. - * `ZWR` - Zimbabwean Dollar (2008) + * `ACTIVE` - ACTIVE + * `ARCHIVED` - ARCHIVED + type: + type: optional + docs: |- + The item's type. - * `ZWL` - Zimbabwean Dollar (2009) - exchange_rate: + * `INVENTORY` - INVENTORY + * `NON_INVENTORY` - NON_INVENTORY + * `SERVICE` - SERVICE + * `UNKNOWN` - UNKNOWN + unit_price: + type: optional + docs: The item's unit price. + purchase_price: + type: optional + docs: The price at which the item is purchased from a vendor. + purchase_account: type: optional - docs: The payment's exchange rate. + docs: References the default account used to record a purchase of the item. validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + format: uuid + sales_account: + type: optional + docs: References the default account used to record a sale. + validation: + format: uuid company: - type: optional - docs: The company the payment belongs to. - total_amount: - type: optional - docs: >- - The total amount of money being paid to the supplier, or customer, - after taxes. - type: - type: optional - docs: |- - The type of the invoice. - - * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE - * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE - tracking_categories: optional>> - accounting_period: - type: optional - docs: The accounting period that the Payment was generated in. - applied_to_lines: - type: optional> - docs: A list of “Payment Applied to Lines” objects. + type: optional + docs: The company the item belongs to. + validation: + format: uuid + purchase_tax_rate: + type: optional + docs: The default purchase tax rate for this item. + validation: + format: uuid + sales_tax_rate: + type: optional + docs: The default sales tax rate for this item. + validation: + format: uuid integration_params: type: optional> access: write-only linked_account_params: type: optional> access: write-only - remote_fields: - type: optional> - access: write-only source: openapi: openapi/openapi.yml - PaymentContact: + PatchedPaymentRequestContact: discriminated: false docs: The supplier, or customer involved in the payment. union: @@ -42804,7 +38351,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentAccount: + PatchedPaymentRequestAccount: discriminated: false docs: The supplier’s or customer’s account in which the payment is made. union: @@ -42815,7 +38362,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentPaymentMethod: + PatchedPaymentRequestPaymentMethod: discriminated: false docs: The method which this payment was made by. union: @@ -42826,7 +38373,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentCurrency: + PatchedPaymentRequestCurrency: discriminated: false docs: >- The payment's currency. @@ -43450,18 +38997,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentCompany: - discriminated: false - docs: The company the payment belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo - source: - openapi: openapi/openapi.yml - inline: true - PaymentType: + PatchedPaymentRequestType: discriminated: false docs: |- The type of the invoice. @@ -43474,7 +39010,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentTrackingCategoriesItem: + PatchedPaymentRequestTrackingCategoriesItem: discriminated: false union: - type: string @@ -43484,7 +39020,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentAccountingPeriod: + PatchedPaymentRequestAccountingPeriod: discriminated: false docs: The accounting period that the Payment was generated in. union: @@ -43495,17 +39031,17 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentAppliedToLinesItem: + PatchedPaymentRequestAppliedToLinesItem: discriminated: false union: - type: string validation: format: uuid - - PaymentLineItem + - PaymentLineItemRequest source: openapi: openapi/openapi.yml inline: true - Payment: + PatchedPaymentRequest: docs: >- # The Payment Object @@ -43519,36 +39055,20 @@ types: Fetch from the `GET Payment` endpoint and view an invoice's payment. properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only transaction_date: type: optional docs: The payment's transaction date. contact: - type: optional + type: optional docs: The supplier, or customer involved in the payment. account: - type: optional + type: optional docs: The supplier’s or customer’s account in which the payment is made. payment_method: - type: optional + type: optional docs: The method which this payment was made by. currency: - type: optional + type: optional docs: >- The payment's currency. @@ -44171,145 +39691,29 @@ types: validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ company: - type: optional + type: optional docs: The company the payment belongs to. + validation: + format: uuid total_amount: type: optional docs: >- The total amount of money being paid to the supplier, or customer, after taxes. type: - type: optional + type: optional docs: |- The type of the invoice. * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE - tracking_categories: optional>> + tracking_categories: optional>> accounting_period: - type: optional + type: optional docs: The accounting period that the Payment was generated in. applied_to_lines: - type: optional> + type: optional> docs: A list of “Payment Applied to Lines” objects. - remote_updated_at: - type: optional - docs: When the third party's payment entry was updated. - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). - access: read-only - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - remote_fields: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - PaymentLineItem: - docs: >- - # The PaymentLineItem Object - - ### Description - - The `PaymentLineItem` object is an applied-to-line on a `Payment` that can - either be a `Invoice`, `CreditNote`, or `JournalEntry`. - - - ### Usage Example - - `Payment` will have a field called `applied-to-lines` which will be an - array of `PaymentLineItemInternalMappingSerializer` objects that can - either be a `Invoice`, `CreditNote`, or `JournalEntry`. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - applied_amount: - type: optional - docs: The amount being applied to the transaction. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - applied_date: - type: optional - docs: The date the payment portion is applied. - related_object_id: - type: optional - docs: >- - The Merge ID of the transaction the payment portion is being applied - to. - validation: - format: uuid - related_object_type: - type: optional - docs: >- - The type of transaction the payment portion is being applied to. - Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE. - source: - openapi: openapi/openapi.yml - PaymentLineItemRequest: - docs: >- - # The PaymentLineItem Object - - ### Description - - The `PaymentLineItem` object is an applied-to-line on a `Payment` that can - either be a `Invoice`, `CreditNote`, or `JournalEntry`. - - - ### Usage Example - - `Payment` will have a field called `applied-to-lines` which will be an - array of `PaymentLineItemInternalMappingSerializer` objects that can - either be a `Invoice`, `CreditNote`, or `JournalEntry`. - properties: - remote_id: - type: optional - docs: The third-party API ID of the matching object. - applied_amount: - type: optional - docs: The amount being applied to the transaction. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - applied_date: - type: optional - docs: The date the payment portion is applied. - related_object_id: - type: optional - docs: >- - The Merge ID of the transaction the payment portion is being applied - to. - validation: - format: uuid - related_object_type: - type: optional - docs: >- - The type of transaction the payment portion is being applied to. - Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE. - validation: - minLength: 1 integration_params: type: optional> access: write-only @@ -44321,83 +39725,7 @@ types: access: write-only source: openapi: openapi/openapi.yml - PaymentMethodMethodType: - discriminated: false - docs: |- - The type of the payment method. - - * `CREDIT_CARD` - CREDIT_CARD - * `DEBIT_CARD` - DEBIT_CARD - * `ACH` - ACH - * `CASH` - CASH - * `CHECK` - CHECK - union: - - MethodTypeEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - PaymentMethod: - docs: >- - # The PaymentMethod Object - - ### Description - - The `PaymentMethod` object defines how a payment against an invoice is - made. - - - ### Usage Example - - Fetch from the `GET PaymentMethod` endpoint and view payment method - information. - properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - method_type: - type: PaymentMethodMethodType - docs: |- - The type of the payment method. - - * `CREDIT_CARD` - CREDIT_CARD - * `DEBIT_CARD` - DEBIT_CARD - * `ACH` - ACH - * `CASH` - CASH - * `CHECK` - CHECK - name: - type: string - docs: The payment method’s name - validation: - maxLength: 255 - is_active: - type: optional - docs: '`True` if the payment method is active, `False` if not.' - remote_updated_at: - type: optional - docs: When the third party's payment method was updated. - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - PaymentRequestContact: + PaymentContact: discriminated: false docs: The supplier, or customer involved in the payment. union: @@ -44408,7 +39736,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentRequestAccount: + PaymentAccount: discriminated: false docs: The supplier’s or customer’s account in which the payment is made. union: @@ -44419,7 +39747,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentRequestPaymentMethod: + PaymentPaymentMethod: discriminated: false docs: The method which this payment was made by. union: @@ -44430,7 +39758,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentRequestCurrency: + PaymentCurrency: discriminated: false docs: >- The payment's currency. @@ -45054,7 +40382,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentRequestCompany: + PaymentCompany: discriminated: false docs: The company the payment belongs to. union: @@ -45065,7 +40393,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentRequestType: + PaymentType: discriminated: false docs: |- The type of the invoice. @@ -45078,7 +40406,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentRequestTrackingCategoriesItem: + PaymentTrackingCategoriesItem: discriminated: false union: - type: string @@ -45088,7 +40416,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentRequestAccountingPeriod: + PaymentAccountingPeriod: discriminated: false docs: The accounting period that the Payment was generated in. union: @@ -45099,17 +40427,17 @@ types: source: openapi: openapi/openapi.yml inline: true - PaymentRequestAppliedToLinesItem: + PaymentAppliedToLinesItem: discriminated: false union: - type: string validation: format: uuid - - PaymentLineItemRequest + - PaymentLineItem source: openapi: openapi/openapi.yml inline: true - PaymentRequest: + Payment: docs: >- # The Payment Object @@ -45123,20 +40451,36 @@ types: Fetch from the `GET Payment` endpoint and view an invoice's payment. properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only transaction_date: type: optional docs: The payment's transaction date. contact: - type: optional + type: optional docs: The supplier, or customer involved in the payment. account: - type: optional + type: optional docs: The supplier’s or customer’s account in which the payment is made. payment_method: - type: optional + type: optional docs: The method which this payment was made by. currency: - type: optional + type: optional docs: >- The payment's currency. @@ -45759,7 +41103,7 @@ types: validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ company: - type: optional + type: optional docs: The company the payment belongs to. total_amount: type: optional @@ -45767,66 +41111,57 @@ types: The total amount of money being paid to the supplier, or customer, after taxes. type: - type: optional + type: optional docs: |- The type of the invoice. * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE - tracking_categories: optional>> + tracking_categories: optional>> accounting_period: - type: optional + type: optional docs: The accounting period that the Payment was generated in. applied_to_lines: - type: optional> + type: optional> docs: A list of “Payment Applied to Lines” objects. - integration_params: - type: optional> - access: write-only - linked_account_params: + remote_updated_at: + type: optional + docs: When the third party's payment entry was updated. + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only + field_mappings: type: optional> - access: write-only + access: read-only + remote_data: + type: optional> + access: read-only remote_fields: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - PaymentResponse: - properties: - model: Payment - warnings: list - errors: list - logs: optional> - source: - openapi: openapi/openapi.yml - PaymentTermCompany: - discriminated: false - docs: The subsidiary that the payment term belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo + type: optional> + access: read-only source: openapi: openapi/openapi.yml - inline: true - PaymentTerm: + PaymentLineItem: docs: >- - # The PaymentTerm Object + # The PaymentLineItem Object ### Description - The `PaymentTerm` object is the agreed-upon conditions between a buyer and - a seller that define the timing, - - amount, and conditions under which payment for goods or services must be - made. + The `PaymentLineItem` object is an applied-to-line on a `Payment` that can + either be a `Invoice`, `CreditNote`, or `JournalEntry`. ### Usage Example - Fetch from the `GET PaymentTerm` endpoint and view payment term - information. + `Payment` will have a field called `applied-to-lines` which will be an + array of `PaymentLineItemInternalMappingSerializer` objects that can + either be a `Invoice`, `CreditNote`, or `JournalEntry`. properties: id: type: optional @@ -45844,96 +41179,110 @@ types: type: optional docs: The datetime that this object was modified by Merge. access: read-only - name: - type: string - docs: The name of the payment term. - validation: - maxLength: 255 - is_active: - type: optional - docs: '`True` if the payment term is active, `False` if not.' - company: - type: optional - docs: The subsidiary that the payment term belongs to. - days_until_due: - type: optional - docs: The number of days after the invoice date that payment is due. - validation: - min: -2147483648 - max: 2147483647 - discount_days: - type: optional - docs: The number of days the invoice must be paid before discounts expire. + applied_amount: + type: optional + docs: The amount being applied to the transaction. validation: - min: -2147483648 - max: 2147483647 - remote_last_modified_at: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + applied_date: type: optional - docs: When the third party's payment term was modified. - field_mappings: - type: optional> - access: read-only - remote_data: - type: optional> - access: read-only - source: - openapi: openapi/openapi.yml - PaymentTypeEnum: - enum: - - ACCOUNTS_PAYABLE - - ACCOUNTS_RECEIVABLE - docs: |- - * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE - * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE - source: - openapi: openapi/openapi.yml - PostingStatusEnum: - enum: - - UNPOSTED - - POSTED - docs: |- - * `UNPOSTED` - UNPOSTED - * `POSTED` - POSTED + docs: The date the payment portion is applied. + related_object_id: + type: optional + docs: >- + The Merge ID of the transaction the payment portion is being applied + to. + validation: + format: uuid + related_object_type: + type: optional + docs: >- + The type of transaction the payment portion is being applied to. + Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE. source: openapi: openapi/openapi.yml - ProjectCompany: - discriminated: false - docs: The subsidiary that the project belongs to. - union: - - type: string + PaymentLineItemRequest: + docs: >- + # The PaymentLineItem Object + + ### Description + + The `PaymentLineItem` object is an applied-to-line on a `Payment` that can + either be a `Invoice`, `CreditNote`, or `JournalEntry`. + + + ### Usage Example + + `Payment` will have a field called `applied-to-lines` which will be an + array of `PaymentLineItemInternalMappingSerializer` objects that can + either be a `Invoice`, `CreditNote`, or `JournalEntry`. + properties: + remote_id: + type: optional + docs: The third-party API ID of the matching object. + applied_amount: + type: optional + docs: The amount being applied to the transaction. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + applied_date: + type: optional + docs: The date the payment portion is applied. + related_object_id: + type: optional + docs: >- + The Merge ID of the transaction the payment portion is being applied + to. validation: format: uuid - - CompanyInfo + related_object_type: + type: optional + docs: >- + The type of transaction the payment portion is being applied to. + Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE. + validation: + minLength: 1 + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + remote_fields: + type: optional> + access: write-only source: openapi: openapi/openapi.yml - inline: true - ProjectContact: + PaymentMethodMethodType: discriminated: false - docs: The supplier, or customer involved in the project. + docs: |- + The type of the payment method. + + * `CREDIT_CARD` - CREDIT_CARD + * `DEBIT_CARD` - DEBIT_CARD + * `ACH` - ACH + * `CASH` - CASH + * `CHECK` - CHECK union: - - type: string - validation: - format: uuid - - Contact + - MethodTypeEnum + - string source: openapi: openapi/openapi.yml inline: true - Project: + PaymentMethod: docs: >- - # The Project Object + # The PaymentMethod Object ### Description - The `Project` object is used to track and manage time, costs, resources, - and revenue for specific initiatives or work efforts. - - It provides classification on transactions for allocating expenses, - revenue, and activities to a specific project for financial reporting. + The `PaymentMethod` object defines how a payment against an invoice is + made. ### Usage Example - Fetch from the `GET Project` endpoint and view project information. + Fetch from the `GET PaymentMethod` endpoint and view payment method + information. properties: id: type: optional @@ -45951,20 +41300,27 @@ types: type: optional docs: The datetime that this object was modified by Merge. access: read-only + method_type: + type: optional + docs: |- + The type of the payment method. + + * `CREDIT_CARD` - CREDIT_CARD + * `DEBIT_CARD` - DEBIT_CARD + * `ACH` - ACH + * `CASH` - CASH + * `CHECK` - CHECK name: type: string - docs: The project’s name + docs: The payment method’s name validation: maxLength: 255 is_active: type: optional - docs: '`True` if the project is active, `False` if the project is not active.' - company: - type: optional - docs: The subsidiary that the project belongs to. - contact: - type: optional - docs: The supplier, or customer involved in the project. + docs: '`True` if the payment method is active, `False` if not.' + remote_updated_at: + type: optional + docs: When the third party's payment method was updated. field_mappings: type: optional> access: read-only @@ -45973,59 +41329,43 @@ types: access: read-only source: openapi: openapi/openapi.yml - PurchaseOrderStatus: - discriminated: false - docs: |- - The purchase order's status. - - * `DRAFT` - DRAFT - * `SUBMITTED` - SUBMITTED - * `AUTHORIZED` - AUTHORIZED - * `BILLED` - BILLED - * `DELETED` - DELETED - union: - - PurchaseOrderStatusEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - PurchaseOrderDeliveryAddress: + PaymentRequestContact: discriminated: false - docs: The purchase order's delivery address. + docs: The supplier, or customer involved in the payment. union: - type: string validation: format: uuid - - Address + - Contact source: openapi: openapi/openapi.yml inline: true - PurchaseOrderVendor: + PaymentRequestAccount: discriminated: false - docs: The party fulfilling the purchase order. + docs: The supplier’s or customer’s account in which the payment is made. union: - type: string validation: format: uuid - - Contact + - Account source: openapi: openapi/openapi.yml inline: true - PurchaseOrderCompany: + PaymentRequestPaymentMethod: discriminated: false - docs: The company the purchase order belongs to. + docs: The method which this payment was made by. union: - type: string validation: format: uuid - - CompanyInfo + - PaymentMethod source: openapi: openapi/openapi.yml inline: true - PurchaseOrderCurrency: + PaymentRequestCurrency: discriminated: false docs: >- - The purchase order's currency. + The payment's currency. * `XUA` - ADB Unit of Account @@ -46646,18 +41986,31 @@ types: source: openapi: openapi/openapi.yml inline: true - PurchaseOrderPaymentTerm: + PaymentRequestCompany: discriminated: false - docs: The payment term that applies to this transaction. + docs: The company the payment belongs to. union: - type: string validation: format: uuid - - PaymentTerm + - CompanyInfo source: openapi: openapi/openapi.yml inline: true - PurchaseOrderTrackingCategoriesItem: + PaymentRequestType: + discriminated: false + docs: |- + The type of the invoice. + + * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE + * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE + union: + - PaymentTypeEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + PaymentRequestTrackingCategoriesItem: discriminated: false union: - type: string @@ -46667,9 +42020,9 @@ types: source: openapi: openapi/openapi.yml inline: true - PurchaseOrderAccountingPeriod: + PaymentRequestAccountingPeriod: discriminated: false - docs: The accounting period that the PurchaseOrder was generated in. + docs: The accounting period that the Payment was generated in. union: - type: string validation: @@ -46678,90 +42031,46 @@ types: source: openapi: openapi/openapi.yml inline: true - PurchaseOrder: + PaymentRequestAppliedToLinesItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - PaymentLineItemRequest + source: + openapi: openapi/openapi.yml + inline: true + PaymentRequest: docs: >- - # The PurchaseOrder Object + # The Payment Object ### Description - A `PurchaseOrder` represents a request to purchase goods or services from - a vendor. It outlines the details of the purchase, such as the items or - services requested, quantities, prices, and delivery details. - - - A `PurchaseOrder` is a crucial component of the procurement process, but - does not typically result in any impact on the company’s general ledger. - The general ledger is typically only affected when the `PurchaseOrder` is - fulfilled as an *Accounts Payable* `Invoice` object (also known as a - Bill). + The `Payment` object represents general payments made towards a specific + transaction. ### Usage Example - Fetch from the `LIST PurchaseOrders` endpoint and view a company's - purchase orders. + Fetch from the `GET Payment` endpoint and view an invoice's payment. properties: - id: - type: optional - validation: - format: uuid - access: read-only - remote_id: - type: optional - docs: The third-party API ID of the matching object. - created_at: - type: optional - docs: The datetime that this object was created by Merge. - access: read-only - modified_at: - type: optional - docs: The datetime that this object was modified by Merge. - access: read-only - status: - type: optional - docs: |- - The purchase order's status. - - * `DRAFT` - DRAFT - * `SUBMITTED` - SUBMITTED - * `AUTHORIZED` - AUTHORIZED - * `BILLED` - BILLED - * `DELETED` - DELETED - issue_date: - type: optional - docs: The purchase order's issue date. - purchase_order_number: - type: optional - docs: The human-readable number of the purchase order. - validation: - maxLength: 100 - delivery_date: + transaction_date: type: optional - docs: The purchase order's delivery date. - delivery_address: - type: optional - docs: The purchase order's delivery address. - customer: - type: optional - docs: The contact making the purchase order. - validation: - format: uuid - vendor: - type: optional - docs: The party fulfilling the purchase order. - memo: - type: optional - docs: A memo attached to the purchase order. - company: - type: optional - docs: The company the purchase order belongs to. - total_amount: - type: optional - docs: The purchase order's total amount. + docs: The payment's transaction date. + contact: + type: optional + docs: The supplier, or customer involved in the payment. + account: + type: optional + docs: The supplier’s or customer’s account in which the payment is made. + payment_method: + type: optional + docs: The method which this payment was made by. currency: - type: optional + type: optional docs: >- - The purchase order's currency. + The payment's currency. * `XUA` - ADB Unit of Account @@ -47378,64 +42687,277 @@ types: * `ZWL` - Zimbabwean Dollar (2009) exchange_rate: type: optional - docs: The purchase order's exchange rate. + docs: The payment's exchange rate. validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - payment_term: - type: optional - docs: The payment term that applies to this transaction. - line_items: - type: optional> - access: read-only - inclusive_of_tax: - type: optional + company: + type: optional + docs: The company the payment belongs to. + total_amount: + type: optional docs: >- - If the transaction is inclusive or exclusive of tax. `True` if - inclusive, `False` if exclusive. - tracking_categories: optional>> + The total amount of money being paid to the supplier, or customer, + after taxes. + type: + type: optional + docs: |- + The type of the invoice. + + * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE + * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE + tracking_categories: optional>> accounting_period: - type: optional - docs: The accounting period that the PurchaseOrder was generated in. - remote_created_at: + type: optional + docs: The accounting period that the Payment was generated in. + applied_to_lines: + type: optional> + docs: A list of “Payment Applied to Lines” objects. + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + remote_fields: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + PaymentResponse: + properties: + model: Payment + warnings: list + errors: list + logs: optional> + source: + openapi: openapi/openapi.yml + PaymentTermCompany: + discriminated: false + docs: The subsidiary that the payment term belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + PaymentTerm: + docs: >- + # The PaymentTerm Object + + ### Description + + The `PaymentTerm` object is the agreed-upon conditions between a buyer and + a seller that define the timing, + + amount, and conditions under which payment for goods or services must be + made. + + + ### Usage Example + + Fetch from the `GET PaymentTerm` endpoint and view payment term + information. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: type: optional - docs: When the third party's purchase order note was created. - remote_updated_at: + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: type: optional - docs: When the third party's purchase order note was updated. - remote_was_deleted: - type: optional - docs: >- - Indicates whether or not this object has been deleted in the third - party platform. Full coverage deletion detection is a premium add-on. - Native deletion detection is offered for free with limited coverage. - [Learn - more](https://docs.merge.dev/integrations/hris/supported-features/). + docs: The datetime that this object was modified by Merge. access: read-only + name: + type: string + docs: The name of the payment term. + validation: + maxLength: 255 + is_active: + type: optional + docs: '`True` if the payment term is active, `False` if not.' + company: + type: optional + docs: The subsidiary that the payment term belongs to. + days_until_due: + type: optional + docs: The number of days after the invoice date that payment is due. + validation: + min: -2147483648 + max: 2147483647 + discount_days: + type: optional + docs: The number of days the invoice must be paid before discounts expire. + validation: + min: -2147483648 + max: 2147483647 + remote_last_modified_at: + type: optional + docs: When the third party's payment term was modified. field_mappings: type: optional> access: read-only remote_data: type: optional> access: read-only - remote_fields: - type: optional> + source: + openapi: openapi/openapi.yml + PaymentTypeEnum: + enum: + - ACCOUNTS_PAYABLE + - ACCOUNTS_RECEIVABLE + docs: |- + * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE + * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE + source: + openapi: openapi/openapi.yml + PostingStatusEnum: + enum: + - UNPOSTED + - POSTED + docs: |- + * `UNPOSTED` - UNPOSTED + * `POSTED` - POSTED + source: + openapi: openapi/openapi.yml + ProjectCompany: + discriminated: false + docs: The subsidiary that the project belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + ProjectContact: + discriminated: false + docs: The supplier, or customer involved in the project. + union: + - type: string + validation: + format: uuid + - Contact + source: + openapi: openapi/openapi.yml + inline: true + Project: + docs: >- + # The Project Object + + ### Description + + The `Project` object is used to track and manage time, costs, resources, + and revenue for specific initiatives or work efforts. + + It provides classification on transactions for allocating expenses, + revenue, and activities to a specific project for financial reporting. + + + ### Usage Example + + Fetch from the `GET Project` endpoint and view project information. + properties: + id: + type: optional + validation: + format: uuid + access: read-only + remote_id: + type: optional + docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only + name: + type: string + docs: The project’s name + validation: + maxLength: 255 + is_active: + type: optional + docs: '`True` if the project is active, `False` if the project is not active.' + company: + type: optional + docs: The subsidiary that the project belongs to. + contact: + type: optional + docs: The supplier, or customer involved in the project. + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> access: read-only source: openapi: openapi/openapi.yml - PurchaseOrderLineItemItem: + PurchaseOrderStatus: discriminated: false + docs: |- + The purchase order's status. + + * `DRAFT` - DRAFT + * `SUBMITTED` - SUBMITTED + * `AUTHORIZED` - AUTHORIZED + * `BILLED` - BILLED + * `DELETED` - DELETED + union: + - PurchaseOrderStatusEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + PurchaseOrderDeliveryAddress: + discriminated: false + docs: The purchase order's delivery address. union: - type: string validation: format: uuid - - Item + - Address source: openapi: openapi/openapi.yml inline: true - PurchaseOrderLineItemCurrency: + PurchaseOrderVendor: + discriminated: false + docs: The party fulfilling the purchase order. + union: + - type: string + validation: + format: uuid + - Contact + source: + openapi: openapi/openapi.yml + inline: true + PurchaseOrderCompany: + discriminated: false + docs: The company the purchase order belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + PurchaseOrderCurrency: discriminated: false docs: >- - The purchase order line item's currency. + The purchase order's currency. * `XUA` - ADB Unit of Account @@ -48056,20 +43578,60 @@ types: source: openapi: openapi/openapi.yml inline: true - PurchaseOrderLineItem: + PurchaseOrderPaymentTerm: + discriminated: false + docs: The payment term that applies to this transaction. + union: + - type: string + validation: + format: uuid + - PaymentTerm + source: + openapi: openapi/openapi.yml + inline: true + PurchaseOrderTrackingCategoriesItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - TrackingCategory + source: + openapi: openapi/openapi.yml + inline: true + PurchaseOrderAccountingPeriod: + discriminated: false + docs: The accounting period that the PurchaseOrder was generated in. + union: + - type: string + validation: + format: uuid + - AccountingPeriod + source: + openapi: openapi/openapi.yml + inline: true + PurchaseOrder: docs: >- - # The PurchaseOrderLineItem Object + # The PurchaseOrder Object ### Description - The `PurchaseOrderLineItem` object is used to represent a purchase order's - line item. + A `PurchaseOrder` represents a request to purchase goods or services from + a vendor. It outlines the details of the purchase, such as the items or + services requested, quantities, prices, and delivery details. + + + A `PurchaseOrder` is a crucial component of the procurement process, but + does not typically result in any impact on the company’s general ledger. + The general ledger is typically only affected when the `PurchaseOrder` is + fulfilled as an *Accounts Payable* `Invoice` object (also known as a + Bill). ### Usage Example - Fetch from the `GET PurchaseOrder` endpoint and view a company's purchase - orders. + Fetch from the `LIST PurchaseOrders` endpoint and view a company's + purchase orders. properties: id: type: optional @@ -48087,44 +43649,51 @@ types: type: optional docs: The datetime that this object was modified by Merge. access: read-only - description: - type: optional - docs: A description of the good being purchased. - unit_price: - type: optional - docs: The line item's unit price. - quantity: - type: optional - docs: The line item's quantity. - item: optional - account: + status: + type: optional + docs: |- + The purchase order's status. + + * `DRAFT` - DRAFT + * `SUBMITTED` - SUBMITTED + * `AUTHORIZED` - AUTHORIZED + * `BILLED` - BILLED + * `DELETED` - DELETED + issue_date: + type: optional + docs: The purchase order's issue date. + purchase_order_number: type: optional - docs: The purchase order line item's account. + docs: The human-readable number of the purchase order. validation: - format: uuid - tracking_category: + maxLength: 100 + delivery_date: + type: optional + docs: The purchase order's delivery date. + delivery_address: + type: optional + docs: The purchase order's delivery address. + customer: type: optional - docs: The purchase order line item's associated tracking category. + docs: The contact making the purchase order. validation: format: uuid - availability: deprecated - tracking_categories: - type: optional>> - docs: The purchase order line item's associated tracking categories. - tax_amount: - type: optional - docs: The purchase order line item's tax amount. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - total_line_amount: + vendor: + type: optional + docs: The party fulfilling the purchase order. + memo: type: optional - docs: The purchase order line item's total amount. - validation: - pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + docs: A memo attached to the purchase order. + company: + type: optional + docs: The company the purchase order belongs to. + total_amount: + type: optional + docs: The purchase order's total amount. currency: - type: optional + type: optional docs: >- - The purchase order line item's currency. + The purchase order's currency. * `XUA` - ADB Unit of Account @@ -48739,21 +44308,32 @@ types: * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) - tax_rate: - type: optional - docs: The tax rate that applies to this line item. - validation: - format: uuid exchange_rate: type: optional - docs: The purchase order line item's exchange rate. + docs: The purchase order's exchange rate. validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ - company: - type: optional - docs: The company the purchase order line item belongs to. - validation: - format: uuid + payment_term: + type: optional + docs: The payment term that applies to this transaction. + line_items: + type: optional> + access: read-only + inclusive_of_tax: + type: optional + docs: >- + If the transaction is inclusive or exclusive of tax. `True` if + inclusive, `False` if exclusive. + tracking_categories: optional>> + accounting_period: + type: optional + docs: The accounting period that the PurchaseOrder was generated in. + remote_created_at: + type: optional + docs: When the third party's purchase order note was created. + remote_updated_at: + type: optional + docs: When the third party's purchase order note was updated. remote_was_deleted: type: optional docs: >- @@ -48763,12 +44343,18 @@ types: [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). access: read-only + field_mappings: + type: optional> + access: read-only + remote_data: + type: optional> + access: read-only remote_fields: type: optional> access: read-only source: openapi: openapi/openapi.yml - PurchaseOrderLineItemRequestItem: + PurchaseOrderLineItemItem: discriminated: false union: - type: string @@ -48778,7 +44364,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PurchaseOrderLineItemRequestCurrency: + PurchaseOrderLineItemCurrency: discriminated: false docs: >- The purchase order line item's currency. @@ -49402,7 +44988,7 @@ types: source: openapi: openapi/openapi.yml inline: true - PurchaseOrderLineItemRequest: + PurchaseOrderLineItem: docs: >- # The PurchaseOrderLineItem Object @@ -49417,9 +45003,22 @@ types: Fetch from the `GET PurchaseOrder` endpoint and view a company's purchase orders. properties: + id: + type: optional + validation: + format: uuid + access: read-only remote_id: type: optional docs: The third-party API ID of the matching object. + created_at: + type: optional + docs: The datetime that this object was created by Merge. + access: read-only + modified_at: + type: optional + docs: The datetime that this object was modified by Merge. + access: read-only description: type: optional docs: A description of the good being purchased. @@ -49429,7 +45028,7 @@ types: quantity: type: optional docs: The line item's quantity. - item: optional + item: optional account: type: optional docs: The purchase order line item's account. @@ -49455,7 +45054,7 @@ types: validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ currency: - type: optional + type: optional docs: >- The purchase order line item's currency. @@ -50087,81 +45686,34 @@ types: docs: The company the purchase order line item belongs to. validation: format: uuid - integration_params: - type: optional> - access: write-only - linked_account_params: - type: optional> - access: write-only + remote_was_deleted: + type: optional + docs: >- + Indicates whether or not this object has been deleted in the third + party platform. Full coverage deletion detection is a premium add-on. + Native deletion detection is offered for free with limited coverage. + [Learn + more](https://docs.merge.dev/integrations/hris/supported-features/). + access: read-only remote_fields: - type: optional> - access: write-only - source: - openapi: openapi/openapi.yml - PurchaseOrderRequestStatus: - discriminated: false - docs: |- - The purchase order's status. - - * `DRAFT` - DRAFT - * `SUBMITTED` - SUBMITTED - * `AUTHORIZED` - AUTHORIZED - * `BILLED` - BILLED - * `DELETED` - DELETED - union: - - PurchaseOrderStatusEnum - - string - source: - openapi: openapi/openapi.yml - inline: true - PurchaseOrderRequestDeliveryAddress: - discriminated: false - docs: The purchase order's delivery address. - union: - - type: string - validation: - format: uuid - - Address - source: - openapi: openapi/openapi.yml - inline: true - PurchaseOrderRequestVendor: - discriminated: false - docs: The party fulfilling the purchase order. - union: - - type: string - validation: - format: uuid - - Contact - source: - openapi: openapi/openapi.yml - inline: true - PurchaseOrderRequestCompany: - discriminated: false - docs: The company the purchase order belongs to. - union: - - type: string - validation: - format: uuid - - CompanyInfo + type: optional> + access: read-only source: openapi: openapi/openapi.yml - inline: true - PurchaseOrderRequestPaymentTerm: + PurchaseOrderLineItemRequestItem: discriminated: false - docs: The payment term that applies to this transaction. union: - type: string validation: format: uuid - - PaymentTerm + - Item source: openapi: openapi/openapi.yml inline: true - PurchaseOrderRequestCurrency: + PurchaseOrderLineItemRequestCurrency: discriminated: false docs: >- - The purchase order's currency. + The purchase order line item's currency. * `XUA` - ADB Unit of Account @@ -50782,74 +46334,62 @@ types: source: openapi: openapi/openapi.yml inline: true - PurchaseOrderRequestTrackingCategoriesItem: - discriminated: false - union: - - type: string - validation: - format: uuid - - TrackingCategory - source: - openapi: openapi/openapi.yml - inline: true - PurchaseOrderRequest: + PurchaseOrderLineItemRequest: docs: >- - # The PurchaseOrder Object + # The PurchaseOrderLineItem Object ### Description - The `PurchaseOrder` object is a record of request for a product or service - between a buyer and seller. + The `PurchaseOrderLineItem` object is used to represent a purchase order's + line item. ### Usage Example - Fetch from the `LIST PurchaseOrders` endpoint and view a company's - purchase orders. + Fetch from the `GET PurchaseOrder` endpoint and view a company's purchase + orders. properties: - status: - type: optional - docs: |- - The purchase order's status. - - * `DRAFT` - DRAFT - * `SUBMITTED` - SUBMITTED - * `AUTHORIZED` - AUTHORIZED - * `BILLED` - BILLED - * `DELETED` - DELETED - issue_date: - type: optional - docs: The purchase order's issue date. - delivery_date: - type: optional - docs: The purchase order's delivery date. - delivery_address: - type: optional - docs: The purchase order's delivery address. - customer: + remote_id: type: optional - docs: The contact making the purchase order. + docs: The third-party API ID of the matching object. + description: + type: optional + docs: A description of the good being purchased. + unit_price: + type: optional + docs: The line item's unit price. + quantity: + type: optional + docs: The line item's quantity. + item: optional + account: + type: optional + docs: The purchase order line item's account. validation: format: uuid - vendor: - type: optional - docs: The party fulfilling the purchase order. - memo: + tracking_category: type: optional - docs: A memo attached to the purchase order. - company: - type: optional - docs: The company the purchase order belongs to. - total_amount: - type: optional - docs: The purchase order's total amount. - payment_term: - type: optional - docs: The payment term that applies to this transaction. + docs: The purchase order line item's associated tracking category. + validation: + format: uuid + availability: deprecated + tracking_categories: + type: optional>> + docs: The purchase order line item's associated tracking categories. + tax_amount: + type: optional + docs: The purchase order line item's tax amount. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + total_line_amount: + type: optional + docs: The purchase order line item's total amount. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ currency: - type: optional + type: optional docs: >- - The purchase order's currency. + The purchase order line item's currency. * `XUA` - ADB Unit of Account @@ -51464,6 +47004,157 @@ types: * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) + tax_rate: + type: optional + docs: The tax rate that applies to this line item. + validation: + format: uuid + exchange_rate: + type: optional + docs: The purchase order line item's exchange rate. + validation: + pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ + company: + type: optional + docs: The company the purchase order line item belongs to. + validation: + format: uuid + integration_params: + type: optional> + access: write-only + linked_account_params: + type: optional> + access: write-only + remote_fields: + type: optional> + access: write-only + source: + openapi: openapi/openapi.yml + PurchaseOrderRequestStatus: + discriminated: false + docs: |- + The purchase order's status. + + * `DRAFT` - DRAFT + * `SUBMITTED` - SUBMITTED + * `AUTHORIZED` - AUTHORIZED + * `BILLED` - BILLED + * `DELETED` - DELETED + union: + - PurchaseOrderStatusEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + PurchaseOrderRequestDeliveryAddress: + discriminated: false + docs: The purchase order's delivery address. + union: + - type: string + validation: + format: uuid + - Address + source: + openapi: openapi/openapi.yml + inline: true + PurchaseOrderRequestVendor: + discriminated: false + docs: The party fulfilling the purchase order. + union: + - type: string + validation: + format: uuid + - Contact + source: + openapi: openapi/openapi.yml + inline: true + PurchaseOrderRequestCompany: + discriminated: false + docs: The company the purchase order belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true + PurchaseOrderRequestPaymentTerm: + discriminated: false + docs: The payment term that applies to this transaction. + union: + - type: string + validation: + format: uuid + - PaymentTerm + source: + openapi: openapi/openapi.yml + inline: true + PurchaseOrderRequestTrackingCategoriesItem: + discriminated: false + union: + - type: string + validation: + format: uuid + - TrackingCategory + source: + openapi: openapi/openapi.yml + inline: true + PurchaseOrderRequest: + docs: >- + # The PurchaseOrder Object + + ### Description + + The `PurchaseOrder` object is a record of request for a product or service + between a buyer and seller. + + + ### Usage Example + + Fetch from the `LIST PurchaseOrders` endpoint and view a company's + purchase orders. + properties: + status: + type: optional + docs: |- + The purchase order's status. + + * `DRAFT` - DRAFT + * `SUBMITTED` - SUBMITTED + * `AUTHORIZED` - AUTHORIZED + * `BILLED` - BILLED + * `DELETED` - DELETED + issue_date: + type: optional + docs: The purchase order's issue date. + delivery_date: + type: optional + docs: The purchase order's delivery date. + delivery_address: + type: optional + docs: The purchase order's delivery address. + customer: + type: optional + docs: The contact making the purchase order. + validation: + format: uuid + vendor: + type: optional + docs: The party fulfilling the purchase order. + memo: + type: optional + docs: A memo attached to the purchase order. + company: + type: optional + docs: The company the purchase order belongs to. + total_amount: + type: optional + docs: The purchase order's total amount. + payment_term: + type: optional + docs: The payment term that applies to this transaction. + currency: optional inclusive_of_tax: type: optional docs: >- @@ -51609,6 +47300,7 @@ types: remote_key_name: optional description: optional is_custom: optional + is_common_model_field: optional is_required: optional field_type: optional field_format: optional @@ -51804,6 +47496,14 @@ types: * `PARTIALLY_SYNCED` - PARTIALLY_SYNCED source: openapi: openapi/openapi.yml + SyncStatusLastSyncResult: + discriminated: false + union: + - LastSyncResultEnum + - string + source: + openapi: openapi/openapi.yml + inline: true SyncStatusStatus: discriminated: false union: @@ -51831,7 +47531,7 @@ types: model_id: string last_sync_start: optional next_sync_start: optional - last_sync_result: optional + last_sync_result: optional last_sync_finished: optional status: SyncStatusStatus is_initial_sync: boolean @@ -52805,6 +48505,17 @@ types: source: openapi: openapi/openapi.yml inline: true + TransactionCompany: + discriminated: false + docs: The company the transaction belongs to. + union: + - type: string + validation: + format: uuid + - CompanyInfo + source: + openapi: openapi/openapi.yml + inline: true TransactionTrackingCategoriesItem: discriminated: false union: @@ -53524,10 +49235,8 @@ types: validation: pattern: ^-?\d{0,32}(?:\.\d{0,16})?$ company: - type: optional + type: optional docs: The company the transaction belongs to. - validation: - format: uuid tracking_categories: optional>> line_items: type: optional> @@ -56502,6 +52211,14 @@ types: source: openapi: openapi/openapi.yml inline: true + VendorCreditLinesItem: + discriminated: false + union: + - unknown + - VendorCreditLine + source: + openapi: openapi/openapi.yml + inline: true VendorCreditTrackingCategoriesItem: discriminated: false union: @@ -57202,7 +52919,7 @@ types: type: optional docs: The company the vendor credit belongs to. lines: - type: optional> + type: optional> access: read-only tracking_categories: optional>> applied_to_lines: diff --git a/.mock/definition/accounting/accountDetails.yml b/.mock/definition/accounting/accountDetails.yml index a9e9606f..300d24e0 100644 --- a/.mock/definition/accounting/accountDetails.yml +++ b/.mock/definition/accounting/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/accounting/accountToken.yml b/.mock/definition/accounting/accountToken.yml index e5fa0475..0f3134f8 100644 --- a/.mock/definition/accounting/accountToken.yml +++ b/.mock/definition/accounting/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/accounting/accountingPeriods.yml b/.mock/definition/accounting/accountingPeriods.yml index d6fc7c6b..4adc5e1b 100644 --- a/.mock/definition/accounting/accountingPeriods.yml +++ b/.mock/definition/accounting/accountingPeriods.yml @@ -43,7 +43,10 @@ service: type: root.PaginatedAccountingPeriodList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -95,7 +98,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 3015f7b1-4d01-460d-bfab-02a52d16cbd0 diff --git a/.mock/definition/accounting/accounts.yml b/.mock/definition/accounting/accounts.yml index c6746098..7f5c1aac 100644 --- a/.mock/definition/accounting/accounts.yml +++ b/.mock/definition/accounting/accounts.yml @@ -127,7 +127,10 @@ service: type: root.PaginatedAccountList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -185,7 +188,8 @@ service: type: root.AccountResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -280,7 +284,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -320,7 +325,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/addresses.yml b/.mock/definition/accounting/addresses.yml index 989f0df1..c8ae7626 100644 --- a/.mock/definition/accounting/addresses.yml +++ b/.mock/definition/accounting/addresses.yml @@ -43,7 +43,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: created_at: '2021-09-15T00:00:00Z' diff --git a/.mock/definition/accounting/asyncPassthrough.yml b/.mock/definition/accounting/asyncPassthrough.yml index da15bafd..2a665ed2 100644 --- a/.mock/definition/accounting/asyncPassthrough.yml +++ b/.mock/definition/accounting/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/accounting/asyncTasks.yml b/.mock/definition/accounting/asyncTasks.yml index 6365c3ab..ae58d998 100644 --- a/.mock/definition/accounting/asyncTasks.yml +++ b/.mock/definition/accounting/asyncTasks.yml @@ -20,7 +20,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: status: QUEUED diff --git a/.mock/definition/accounting/attachments.yml b/.mock/definition/accounting/attachments.yml index cae3762b..2487a3cf 100644 --- a/.mock/definition/accounting/attachments.yml +++ b/.mock/definition/accounting/attachments.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedAccountingAttachmentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -120,7 +123,8 @@ service: type: root.AccountingAttachmentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -193,7 +197,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -226,7 +231,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/auditTrail.yml b/.mock/definition/accounting/auditTrail.yml index 6e1b8672..0dcfb086 100644 --- a/.mock/definition/accounting/auditTrail.yml +++ b/.mock/definition/accounting/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/accounting/availableActions.yml b/.mock/definition/accounting/availableActions.yml index 35fca3fa..e7a930de 100644 --- a/.mock/definition/accounting/availableActions.yml +++ b/.mock/definition/accounting/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/accounting/balanceSheets.yml b/.mock/definition/accounting/balanceSheets.yml index dde810e4..28152b37 100644 --- a/.mock/definition/accounting/balanceSheets.yml +++ b/.mock/definition/accounting/balanceSheets.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedBalanceSheetList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -169,7 +172,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46 diff --git a/.mock/definition/accounting/bankFeedAccounts.yml b/.mock/definition/accounting/bankFeedAccounts.yml index 2e64d197..a5d6ed06 100644 --- a/.mock/definition/accounting/bankFeedAccounts.yml +++ b/.mock/definition/accounting/bankFeedAccounts.yml @@ -43,7 +43,10 @@ service: type: root.PaginatedBankFeedAccountList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -96,7 +99,8 @@ service: type: root.BankFeedAccountResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -173,7 +177,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b26fd49a-cbae-470a-a8f8-bcbc119e0390 @@ -210,7 +215,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/bankFeedTransactions.yml b/.mock/definition/accounting/bankFeedTransactions.yml index 682615d0..7a1d41c9 100644 --- a/.mock/definition/accounting/bankFeedTransactions.yml +++ b/.mock/definition/accounting/bankFeedTransactions.yml @@ -74,7 +74,10 @@ service: type: root.PaginatedBankFeedTransactionList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -122,7 +125,8 @@ service: type: root.BankFeedTransactionResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -197,7 +201,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b26fd49a-cbae-470a-a8f8-bcbc119e0390 @@ -227,7 +232,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/cashFlowStatements.yml b/.mock/definition/accounting/cashFlowStatements.yml index 179afb9c..15bb6aa4 100644 --- a/.mock/definition/accounting/cashFlowStatements.yml +++ b/.mock/definition/accounting/cashFlowStatements.yml @@ -74,7 +74,10 @@ service: type: root.PaginatedCashFlowStatementList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -85,7 +88,8 @@ service: created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' name: CashFlow - currency: XUA + currency: + key: value company: company start_period: '2020-01-01T00:00:00Z' end_period: '2020-03-31T00:00:00Z' @@ -170,7 +174,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 5b3c1341-a20f-4e51-b72c-f3830a16c97b @@ -178,7 +183,8 @@ service: created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' name: CashFlow - currency: XUA + currency: + key: value company: company start_period: '2020-01-01T00:00:00Z' end_period: '2020-03-31T00:00:00Z' diff --git a/.mock/definition/accounting/companyInfo.yml b/.mock/definition/accounting/companyInfo.yml index 488a4308..33953306 100644 --- a/.mock/definition/accounting/companyInfo.yml +++ b/.mock/definition/accounting/companyInfo.yml @@ -86,7 +86,10 @@ service: type: root.PaginatedCompanyInfoList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -159,7 +162,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982 diff --git a/.mock/definition/accounting/contacts.yml b/.mock/definition/accounting/contacts.yml index ba75cfb4..c809b0ff 100644 --- a/.mock/definition/accounting/contacts.yml +++ b/.mock/definition/accounting/contacts.yml @@ -137,7 +137,10 @@ service: type: root.PaginatedContactList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -203,7 +206,8 @@ service: type: root.ContactResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -311,7 +315,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: c640b80b-fac9-409f-aa19-1f9221aec445 @@ -361,7 +366,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -582,7 +588,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -593,6 +602,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/creditNotes.yml b/.mock/definition/accounting/creditNotes.yml index edd13752..880ab247 100644 --- a/.mock/definition/accounting/creditNotes.yml +++ b/.mock/definition/accounting/creditNotes.yml @@ -659,7 +659,10 @@ service: type: root.PaginatedCreditNoteList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -755,7 +758,8 @@ service: type: root.CreditNoteResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -888,7 +892,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 8d9fd929-436c-4fd4-a48b-0c61f68d6178 @@ -917,7 +922,6 @@ service: unit_price: '5.0' tax_rate: 8d9fd929-436c-4fd4-a48b-0c61f68d6178 total_line_amount: '5.0' - tracking_category: tracking_category tracking_categories: - 8d9fd929-436c-4fd4-a48b-0c61f68d6178 - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -969,7 +973,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/deleteAccount.yml b/.mock/definition/accounting/deleteAccount.yml index 402b4e72..dd6432e8 100644 --- a/.mock/definition/accounting/deleteAccount.yml +++ b/.mock/definition/accounting/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/accounting/employees.yml b/.mock/definition/accounting/employees.yml index bc9f9fdb..d77b43e3 100644 --- a/.mock/definition/accounting/employees.yml +++ b/.mock/definition/accounting/employees.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedEmployeeList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -133,7 +136,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: c640b80b-fac9-409f-aa19-1f9221aec445 diff --git a/.mock/definition/accounting/expenseReports.yml b/.mock/definition/accounting/expenseReports.yml index d8794980..56f9e3f8 100644 --- a/.mock/definition/accounting/expenseReports.yml +++ b/.mock/definition/accounting/expenseReports.yml @@ -262,7 +262,10 @@ service: type: root.PaginatedExpenseReportList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -274,7 +277,7 @@ service: modified_at: '2024-01-31T14:30:00Z' report_date: '2024-01-31T00:00:00Z' report_identifier: EXP-2024-001 - employee: b9a9b824-6172-4d63-9d90-1c8a86c4f3b1 + employee: employee status: DRAFT total_amount: 150 lines: @@ -305,7 +308,7 @@ service: remote_was_deleted: false currency: XUA description: January 2024 Travel Expenses - accounting_period: 7d793c67-9f72-4a6b-9256-3936f237b0d9 + accounting_period: accounting_period company: company tracking_categories: - a1b2c3d4-e5f6-4a5b-9c3d-2e1f0a9b8c7d @@ -349,7 +352,8 @@ service: type: root.ExpenseReportResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: tracking_categories: @@ -364,7 +368,7 @@ service: modified_at: '2024-01-31T14:30:00Z' report_date: '2024-01-31T00:00:00Z' report_identifier: EXP-2024-001 - employee: b9a9b824-6172-4d63-9d90-1c8a86c4f3b1 + employee: employee status: DRAFT total_amount: 150 lines: @@ -395,7 +399,7 @@ service: remote_was_deleted: false currency: XUA description: January 2024 Travel Expenses - accounting_period: 7d793c67-9f72-4a6b-9256-3936f237b0d9 + accounting_period: accounting_period company: company tracking_categories: - a1b2c3d4-e5f6-4a5b-9c3d-2e1f0a9b8c7d @@ -487,7 +491,10 @@ service: examples: - path-parameters: expense_report_id: expense_report_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -501,7 +508,8 @@ service: description: Client lunch meeting expense_date: '2024-01-15T00:00:00Z' amount: 50 - currency: XUA + currency: + key: value exchange_rate: exchange_rate is_billable: true tracking_categories: @@ -559,7 +567,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 123e4567-e89b-12d3-a456-426614174000 @@ -568,7 +577,7 @@ service: modified_at: '2024-01-31T14:30:00Z' report_date: '2024-01-31T00:00:00Z' report_identifier: EXP-2024-001 - employee: b9a9b824-6172-4d63-9d90-1c8a86c4f3b1 + employee: employee status: DRAFT total_amount: 150 lines: @@ -601,7 +610,7 @@ service: - remote_field_class: remote_field_class currency: XUA description: January 2024 Travel Expenses - accounting_period: 7d793c67-9f72-4a6b-9256-3936f237b0d9 + accounting_period: accounting_period company: company tracking_categories: - a1b2c3d4-e5f6-4a5b-9c3d-2e1f0a9b8c7d @@ -669,7 +678,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -680,6 +692,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -697,7 +710,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -918,7 +932,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -929,6 +946,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/expenses.yml b/.mock/definition/accounting/expenses.yml index 98c48edf..4a409f71 100644 --- a/.mock/definition/accounting/expenses.yml +++ b/.mock/definition/accounting/expenses.yml @@ -334,7 +334,10 @@ service: type: root.PaginatedExpenseList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -433,7 +436,8 @@ service: type: root.ExpenseResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -564,7 +568,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -591,7 +596,6 @@ service: modified_at: '2021-10-16T00:00:00Z' item: b38c59b0-a9d7-4740-b1ee-5436c6751e3d net_amount: 25.54 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -612,7 +616,6 @@ service: modified_at: '2021-10-16T00:00:00Z' item: b38c59b0-a9d7-4740-b1ee-5436c6751e3d net_amount: 10 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -695,7 +698,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -706,6 +712,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -723,7 +730,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -944,7 +952,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -955,6 +966,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/fieldMapping.yml b/.mock/definition/accounting/fieldMapping.yml index 66389088..70f7267f 100644 --- a/.mock/definition/accounting/fieldMapping.yml +++ b/.mock/definition/accounting/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: @@ -517,7 +518,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -584,7 +586,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -666,7 +669,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -737,7 +741,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: @@ -1107,7 +1112,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: diff --git a/.mock/definition/accounting/forceResync.yml b/.mock/definition/accounting/forceResync.yml index 8e7e969a..23d80d64 100644 --- a/.mock/definition/accounting/forceResync.yml +++ b/.mock/definition/accounting/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Invoice diff --git a/.mock/definition/accounting/generalLedgerTransactions.yml b/.mock/definition/accounting/generalLedgerTransactions.yml index 38fe7292..5e43d543 100644 --- a/.mock/definition/accounting/generalLedgerTransactions.yml +++ b/.mock/definition/accounting/generalLedgerTransactions.yml @@ -143,7 +143,10 @@ service: type: root.PaginatedGeneralLedgerTransactionList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -228,7 +231,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b26fd49a-cbae-470a-a8f8-bcbc119e0390 diff --git a/.mock/definition/accounting/generateKey.yml b/.mock/definition/accounting/generateKey.yml index 4d79b8ce..7ec4bf68 100644 --- a/.mock/definition/accounting/generateKey.yml +++ b/.mock/definition/accounting/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/accounting/incomeStatements.yml b/.mock/definition/accounting/incomeStatements.yml index 92f62e77..f1da1a7b 100644 --- a/.mock/definition/accounting/incomeStatements.yml +++ b/.mock/definition/accounting/incomeStatements.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedIncomeStatementList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -183,7 +186,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae diff --git a/.mock/definition/accounting/invoices.yml b/.mock/definition/accounting/invoices.yml index a3d88012..963f67bb 100644 --- a/.mock/definition/accounting/invoices.yml +++ b/.mock/definition/accounting/invoices.yml @@ -27076,7 +27076,10 @@ service: type: root.PaginatedInvoiceList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -27195,7 +27198,8 @@ service: type: root.InvoiceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -27353,7 +27357,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46 @@ -27409,7 +27414,6 @@ service: item: 5b3c1341-a20f-4e51-b72c-f3830a16c97b account: cd0f32d4-a493-11ec-b909-0242ac120002 tax_rate: a12e7c20-1922-9df7-s75n-edfeewnn7384 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -27485,7 +27489,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -27643,7 +27648,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -27654,6 +27662,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -27675,7 +27684,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -27859,7 +27869,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -28080,7 +28091,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -28091,6 +28105,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/issues.yml b/.mock/definition/accounting/issues.yml index 58c4f3b1..f7568739 100644 --- a/.mock/definition/accounting/issues.yml +++ b/.mock/definition/accounting/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/accounting/items.yml b/.mock/definition/accounting/items.yml index 29a34438..67a784e9 100644 --- a/.mock/definition/accounting/items.yml +++ b/.mock/definition/accounting/items.yml @@ -207,7 +207,10 @@ service: type: root.PaginatedItemList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -265,7 +268,8 @@ service: type: root.ItemResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -360,7 +364,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: d2f972d0-2526-434b-9409-4c3b468e08f0 @@ -419,7 +424,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -486,7 +492,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -670,7 +677,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/journalEntries.yml b/.mock/definition/accounting/journalEntries.yml index feb7bad3..e471027d 100644 --- a/.mock/definition/accounting/journalEntries.yml +++ b/.mock/definition/accounting/journalEntries.yml @@ -338,7 +338,10 @@ service: type: root.PaginatedJournalEntryList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -431,7 +434,8 @@ service: type: root.JournalEntryResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -556,7 +560,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -580,7 +585,6 @@ service: modified_at: '2021-10-16T00:00:00Z' account: 9d892439-5fab-4dbb-8bd8-34f7f96c7912 net_amount: 25.54 - tracking_category: tracking_category tracking_categories: - d25d609b-945f-4762-b55a-1c8fb220c43c - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -602,7 +606,6 @@ service: modified_at: '2021-10-16T00:00:00Z' account: f963f34d-3d2f-4f77-b557-cf36bc7e6498 net_amount: 10 - tracking_category: tracking_category tracking_categories: - d25d609b-945f-4762-b55a-1c8fb220c43c - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -690,7 +693,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -701,6 +707,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -718,7 +725,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -939,7 +947,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -950,6 +961,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/linkToken.yml b/.mock/definition/accounting/linkToken.yml index 5a2f0a6f..1d7aa0a0 100644 --- a/.mock/definition/accounting/linkToken.yml +++ b/.mock/definition/accounting/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/accounting/linkedAccounts.yml b/.mock/definition/accounting/linkedAccounts.yml index aa8806e8..a831126a 100644 --- a/.mock/definition/accounting/linkedAccounts.yml +++ b/.mock/definition/accounting/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/accounting/passthrough.yml b/.mock/definition/accounting/passthrough.yml index 25ab767c..db79aa9e 100644 --- a/.mock/definition/accounting/passthrough.yml +++ b/.mock/definition/accounting/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/accounting/paymentMethods.yml b/.mock/definition/accounting/paymentMethods.yml index c53c952c..844d0b85 100644 --- a/.mock/definition/accounting/paymentMethods.yml +++ b/.mock/definition/accounting/paymentMethods.yml @@ -43,7 +43,10 @@ service: type: root.PaginatedPaymentMethodList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -95,7 +98,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 diff --git a/.mock/definition/accounting/paymentTerms.yml b/.mock/definition/accounting/paymentTerms.yml index 688ed9c3..edf23455 100644 --- a/.mock/definition/accounting/paymentTerms.yml +++ b/.mock/definition/accounting/paymentTerms.yml @@ -48,7 +48,10 @@ service: type: root.PaginatedPaymentTermList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -107,7 +110,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 diff --git a/.mock/definition/accounting/payments.yml b/.mock/definition/accounting/payments.yml index be829a43..8a628d65 100644 --- a/.mock/definition/accounting/payments.yml +++ b/.mock/definition/accounting/payments.yml @@ -624,7 +624,10 @@ service: type: root.PaginatedPaymentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -705,7 +708,8 @@ service: type: root.PaymentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -818,7 +822,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b26fd49a-cbae-470a-a8f8-bcbc119e0390 @@ -902,7 +907,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -1025,7 +1031,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1036,6 +1045,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -1057,7 +1067,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -1241,7 +1252,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -1462,7 +1474,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1473,6 +1488,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/phoneNumbers.yml b/.mock/definition/accounting/phoneNumbers.yml index b6732385..75ad3e16 100644 --- a/.mock/definition/accounting/phoneNumbers.yml +++ b/.mock/definition/accounting/phoneNumbers.yml @@ -33,7 +33,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: created_at: '2021-09-15T00:00:00Z' diff --git a/.mock/definition/accounting/projects.yml b/.mock/definition/accounting/projects.yml index c83c6626..add59523 100644 --- a/.mock/definition/accounting/projects.yml +++ b/.mock/definition/accounting/projects.yml @@ -89,7 +89,10 @@ service: type: root.PaginatedProjectList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -146,7 +149,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 diff --git a/.mock/definition/accounting/purchaseOrders.yml b/.mock/definition/accounting/purchaseOrders.yml index e0157639..bc57e698 100644 --- a/.mock/definition/accounting/purchaseOrders.yml +++ b/.mock/definition/accounting/purchaseOrders.yml @@ -634,7 +634,10 @@ service: type: root.PaginatedPurchaseOrderList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -737,7 +740,8 @@ service: type: root.PurchaseOrderResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -882,7 +886,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0048ea5b-911e-4dff-9364-92070dea62ff @@ -912,7 +917,6 @@ service: quantity: 10 item: 0958cbc6-6040-430a-848e-aafacbadf4ae account: account - tracking_category: tracking_category tracking_categories: - f1214c24-2702-4617-b74b-3ddecfc0d384 - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -935,7 +939,6 @@ service: quantity: 10 item: 249c9faa-3045-4a31-953b-8f22d3613301 account: account - tracking_category: tracking_category tracking_categories: - f1214c24-2702-4617-b74b-3ddecfc0d384 - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -1020,7 +1023,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1031,6 +1037,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -1048,7 +1055,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -1269,7 +1277,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1280,6 +1291,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/regenerateKey.yml b/.mock/definition/accounting/regenerateKey.yml index 39fe26f9..fa714152 100644 --- a/.mock/definition/accounting/regenerateKey.yml +++ b/.mock/definition/accounting/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/accounting/scopes.yml b/.mock/definition/accounting/scopes.yml index ab81c591..4c990463 100644 --- a/.mock/definition/accounting/scopes.yml +++ b/.mock/definition/accounting/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/accounting/syncStatus.yml b/.mock/definition/accounting/syncStatus.yml index 38dcf2ce..2a5e4eb4 100644 --- a/.mock/definition/accounting/syncStatus.yml +++ b/.mock/definition/accounting/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/accounting/taxRates.yml b/.mock/definition/accounting/taxRates.yml index 3ff15195..c2695fb6 100644 --- a/.mock/definition/accounting/taxRates.yml +++ b/.mock/definition/accounting/taxRates.yml @@ -75,7 +75,10 @@ service: type: root.PaginatedTaxRateList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -146,7 +149,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b82302de-852e-4e60-b050-edf9da3b7c02 diff --git a/.mock/definition/accounting/trackingCategories.yml b/.mock/definition/accounting/trackingCategories.yml index 2e3f062f..b63996f9 100644 --- a/.mock/definition/accounting/trackingCategories.yml +++ b/.mock/definition/accounting/trackingCategories.yml @@ -95,7 +95,10 @@ service: type: root.PaginatedTrackingCategoryList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -160,7 +163,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 diff --git a/.mock/definition/accounting/transactions.yml b/.mock/definition/accounting/transactions.yml index 94a999db..bb707b3d 100644 --- a/.mock/definition/accounting/transactions.yml +++ b/.mock/definition/accounting/transactions.yml @@ -205,7 +205,10 @@ service: type: root.PaginatedTransactionList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -224,7 +227,7 @@ service: total_amount: total_amount currency: XUA exchange_rate: '2.9' - company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 + company: company tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -308,7 +311,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0048ea5b-911e-4dff-9364-92070dea62ff @@ -324,7 +328,7 @@ service: total_amount: total_amount currency: XUA exchange_rate: '2.9' - company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 + company: company tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -339,7 +343,6 @@ service: quantity: '10.0' item: 0958cbc6-6040-430a-848e-aafacbadf4ae account: 2b38c085-2620-4269-b5ec-75dd9095ed2c - tracking_category: tracking_category tracking_categories: - f1214c24-2702-4617-b74b-3ddecfc0d384 - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -359,7 +362,6 @@ service: quantity: '10.0' item: 249c9faa-3045-4a31-953b-8f22d3613301 account: 3e442c5d-8f51-4103-b5c9-dcee39c30a08 - tracking_category: tracking_category tracking_categories: - f1214c24-2702-4617-b74b-3ddecfc0d384 - 9b840d2-686a-465a-8a8e-7b028498f8e4 diff --git a/.mock/definition/accounting/vendorCredits.yml b/.mock/definition/accounting/vendorCredits.yml index 39b41415..b8507e7c 100644 --- a/.mock/definition/accounting/vendorCredits.yml +++ b/.mock/definition/accounting/vendorCredits.yml @@ -203,7 +203,10 @@ service: type: root.PaginatedVendorCreditList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -298,7 +301,8 @@ service: type: root.VendorCreditResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -420,7 +424,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -441,7 +446,6 @@ service: created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' net_amount: 25.54 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -459,7 +463,6 @@ service: created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' net_amount: 10 - tracking_category: tracking_category tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -507,7 +510,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/accounting/webhookReceivers.yml b/.mock/definition/accounting/webhookReceivers.yml index 0c90c826..c7bb86ce 100644 --- a/.mock/definition/accounting/webhookReceivers.yml +++ b/.mock/definition/accounting/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/ats/__package__.yml b/.mock/definition/ats/__package__.yml index 8f3c7857..e280d693 100644 --- a/.mock/definition/ats/__package__.yml +++ b/.mock/definition/ats/__package__.yml @@ -1974,6 +1974,7 @@ types: - CREATED_TEST_API_KEY - DELETED_TEST_API_KEY - REGENERATED_PRODUCTION_API_KEY + - REGENERATED_WEBHOOK_SIGNATURE - INVITED_USER - TWO_FACTOR_AUTH_ENABLED - TWO_FACTOR_AUTH_DISABLED diff --git a/.mock/definition/ats/accountDetails.yml b/.mock/definition/ats/accountDetails.yml index fe37fa60..a09c4849 100644 --- a/.mock/definition/ats/accountDetails.yml +++ b/.mock/definition/ats/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/ats/accountToken.yml b/.mock/definition/ats/accountToken.yml index 0c372796..3c055421 100644 --- a/.mock/definition/ats/accountToken.yml +++ b/.mock/definition/ats/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/ats/activities.yml b/.mock/definition/ats/activities.yml index 362836ad..2ed08a54 100644 --- a/.mock/definition/ats/activities.yml +++ b/.mock/definition/ats/activities.yml @@ -115,7 +115,10 @@ service: type: root.PaginatedActivityList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -170,7 +173,8 @@ service: type: root.ActivityResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -262,7 +266,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 @@ -298,7 +303,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/applications.yml b/.mock/definition/ats/applications.yml index 4a5822f9..a6c86947 100644 --- a/.mock/definition/ats/applications.yml +++ b/.mock/definition/ats/applications.yml @@ -1426,7 +1426,10 @@ service: type: root.PaginatedApplicationList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1498,7 +1501,8 @@ service: type: root.ApplicationResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -1586,7 +1590,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 92e8a369-fffe-430d-b93a-f7e8a16563f1 @@ -1655,7 +1660,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -1727,7 +1733,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/asyncPassthrough.yml b/.mock/definition/ats/asyncPassthrough.yml index 94686f10..1ab045cf 100644 --- a/.mock/definition/ats/asyncPassthrough.yml +++ b/.mock/definition/ats/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/ats/attachments.yml b/.mock/definition/ats/attachments.yml index 14b45b1b..901d2eac 100644 --- a/.mock/definition/ats/attachments.yml +++ b/.mock/definition/ats/attachments.yml @@ -82,7 +82,10 @@ service: type: root.PaginatedAttachmentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -134,7 +137,8 @@ service: type: root.AttachmentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -223,7 +227,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: c640b80b-fac9-409f-aa19-1f9221aec445 @@ -256,7 +261,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/auditTrail.yml b/.mock/definition/ats/auditTrail.yml index 36833ffe..d5a8c615 100644 --- a/.mock/definition/ats/auditTrail.yml +++ b/.mock/definition/ats/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/ats/availableActions.yml b/.mock/definition/ats/availableActions.yml index 8e529df3..2f7515df 100644 --- a/.mock/definition/ats/availableActions.yml +++ b/.mock/definition/ats/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/ats/candidates.yml b/.mock/definition/ats/candidates.yml index e5f23a79..e38f44e9 100644 --- a/.mock/definition/ats/candidates.yml +++ b/.mock/definition/ats/candidates.yml @@ -110,7 +110,10 @@ service: type: root.PaginatedCandidateList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -194,7 +197,8 @@ service: type: root.CandidateResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -305,7 +309,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 521b18c2-4d01-4297-b451-19858d07c133 @@ -393,7 +398,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -497,7 +503,8 @@ service: examples: - path-parameters: model_id: model_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: reason: GENERAL_CUSTOMER_REQUEST metaPatchRetrieve: @@ -516,7 +523,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -700,7 +708,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/deleteAccount.yml b/.mock/definition/ats/deleteAccount.yml index 6255a393..9ffe1a71 100644 --- a/.mock/definition/ats/deleteAccount.yml +++ b/.mock/definition/ats/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/ats/departments.yml b/.mock/definition/ats/departments.yml index 8f001f43..ec1c4fa0 100644 --- a/.mock/definition/ats/departments.yml +++ b/.mock/definition/ats/departments.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedDepartmentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -114,7 +117,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 5b3c1341-a20f-4e51-b72c-f3830a16c97b diff --git a/.mock/definition/ats/eeocs.yml b/.mock/definition/ats/eeocs.yml index 91dbf6b9..b14f676d 100644 --- a/.mock/definition/ats/eeocs.yml +++ b/.mock/definition/ats/eeocs.yml @@ -203,7 +203,10 @@ service: type: root.PaginatedEeocList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -273,7 +276,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: f7dd7b4f-237e-4772-8bd4-3246384c6c58 diff --git a/.mock/definition/ats/fieldMapping.yml b/.mock/definition/ats/fieldMapping.yml index 9d92fea8..949a75b5 100644 --- a/.mock/definition/ats/fieldMapping.yml +++ b/.mock/definition/ats/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Activity: @@ -357,7 +358,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -424,7 +426,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -506,7 +509,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -577,7 +581,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Activity: @@ -821,7 +826,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Activity: diff --git a/.mock/definition/ats/forceResync.yml b/.mock/definition/ats/forceResync.yml index 8a603992..b939eabe 100644 --- a/.mock/definition/ats/forceResync.yml +++ b/.mock/definition/ats/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Candidate diff --git a/.mock/definition/ats/generateKey.yml b/.mock/definition/ats/generateKey.yml index 40a39dcb..c7da4da8 100644 --- a/.mock/definition/ats/generateKey.yml +++ b/.mock/definition/ats/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/ats/interviews.yml b/.mock/definition/ats/interviews.yml index aa95289c..0d25c536 100644 --- a/.mock/definition/ats/interviews.yml +++ b/.mock/definition/ats/interviews.yml @@ -152,7 +152,10 @@ service: type: root.PaginatedScheduledInterviewList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -212,7 +215,8 @@ service: type: root.ScheduledInterviewResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} remote_user_id: remote_user_id @@ -309,7 +313,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b8faf072-98b9-4445-8a9a-6b4950efca19 @@ -350,7 +355,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ats/issues.yml b/.mock/definition/ats/issues.yml index 4984ce4e..51de2a7d 100644 --- a/.mock/definition/ats/issues.yml +++ b/.mock/definition/ats/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/ats/jobInterviewStages.yml b/.mock/definition/ats/jobInterviewStages.yml index 5753b281..d1a7f9fd 100644 --- a/.mock/definition/ats/jobInterviewStages.yml +++ b/.mock/definition/ats/jobInterviewStages.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedJobInterviewStageList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -129,7 +132,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: f9813dd5-e70b-484c-91d8-00acd6065b07 diff --git a/.mock/definition/ats/jobPostings.yml b/.mock/definition/ats/jobPostings.yml index 859b5bb4..c888c890 100644 --- a/.mock/definition/ats/jobPostings.yml +++ b/.mock/definition/ats/jobPostings.yml @@ -95,7 +95,10 @@ service: type: root.PaginatedJobPostingList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -161,7 +164,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 156a2bef-57e5-4def-8ed2-7c41bd9a554t diff --git a/.mock/definition/ats/jobs.yml b/.mock/definition/ats/jobs.yml index 7ec7441a..b5f780af 100644 --- a/.mock/definition/ats/jobs.yml +++ b/.mock/definition/ats/jobs.yml @@ -243,7 +243,10 @@ service: type: root.PaginatedJobList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -334,7 +337,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8 @@ -427,7 +431,10 @@ service: examples: - path-parameters: job_id: job_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ats/linkToken.yml b/.mock/definition/ats/linkToken.yml index 1548f705..a6b77072 100644 --- a/.mock/definition/ats/linkToken.yml +++ b/.mock/definition/ats/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/ats/linkedAccounts.yml b/.mock/definition/ats/linkedAccounts.yml index 7acf3099..1f942677 100644 --- a/.mock/definition/ats/linkedAccounts.yml +++ b/.mock/definition/ats/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/ats/offers.yml b/.mock/definition/ats/offers.yml index cb2591c8..bfbc9bb7 100644 --- a/.mock/definition/ats/offers.yml +++ b/.mock/definition/ats/offers.yml @@ -102,7 +102,10 @@ service: type: root.PaginatedOfferList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -173,7 +176,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: dd85625c-6a59-446f-a317-6de64d83bae7 diff --git a/.mock/definition/ats/offices.yml b/.mock/definition/ats/offices.yml index 080386b8..d8009929 100644 --- a/.mock/definition/ats/offices.yml +++ b/.mock/definition/ats/offices.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedOfficeList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -115,7 +118,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46 diff --git a/.mock/definition/ats/passthrough.yml b/.mock/definition/ats/passthrough.yml index 7141a6bd..a3dff513 100644 --- a/.mock/definition/ats/passthrough.yml +++ b/.mock/definition/ats/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/ats/regenerateKey.yml b/.mock/definition/ats/regenerateKey.yml index 1ea4149a..5db09f20 100644 --- a/.mock/definition/ats/regenerateKey.yml +++ b/.mock/definition/ats/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/ats/rejectReasons.yml b/.mock/definition/ats/rejectReasons.yml index 1552c46c..fc100819 100644 --- a/.mock/definition/ats/rejectReasons.yml +++ b/.mock/definition/ats/rejectReasons.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedRejectReasonList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -114,7 +117,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 8be99a4a-f8d4-4339-bf1e-30eac970e217 diff --git a/.mock/definition/ats/scopes.yml b/.mock/definition/ats/scopes.yml index 422d3fa4..bdaf6ed0 100644 --- a/.mock/definition/ats/scopes.yml +++ b/.mock/definition/ats/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/ats/scorecards.yml b/.mock/definition/ats/scorecards.yml index 6f83e854..a5f93514 100644 --- a/.mock/definition/ats/scorecards.yml +++ b/.mock/definition/ats/scorecards.yml @@ -119,7 +119,10 @@ service: type: root.PaginatedScorecardList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -189,7 +192,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 3eab2f17-eeb1-450d-97f0-029d8be1e06f diff --git a/.mock/definition/ats/syncStatus.yml b/.mock/definition/ats/syncStatus.yml index 99b9bd54..81b1fa9c 100644 --- a/.mock/definition/ats/syncStatus.yml +++ b/.mock/definition/ats/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ats/tags.yml b/.mock/definition/ats/tags.yml index f6007d90..106e5cf9 100644 --- a/.mock/definition/ats/tags.yml +++ b/.mock/definition/ats/tags.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedTagList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ats/users.yml b/.mock/definition/ats/users.yml index 3bd2db1f..90a2bb54 100644 --- a/.mock/definition/ats/users.yml +++ b/.mock/definition/ats/users.yml @@ -81,7 +81,10 @@ service: type: root.PaginatedRemoteUserList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -146,7 +149,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: b82302de-852e-4e60-b050-edf9da3b7c02 diff --git a/.mock/definition/ats/webhookReceivers.yml b/.mock/definition/ats/webhookReceivers.yml index 91d2ae65..76339c9f 100644 --- a/.mock/definition/ats/webhookReceivers.yml +++ b/.mock/definition/ats/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/crm/__package__.yml b/.mock/definition/crm/__package__.yml index 4ad8f75d..adb6df8b 100644 --- a/.mock/definition/crm/__package__.yml +++ b/.mock/definition/crm/__package__.yml @@ -5158,6 +5158,7 @@ types: remote_key_name: optional description: optional is_custom: optional + is_common_model_field: optional is_required: optional field_type: optional field_format: optional diff --git a/.mock/definition/crm/accountDetails.yml b/.mock/definition/crm/accountDetails.yml index 4fe53ba5..2d2405a1 100644 --- a/.mock/definition/crm/accountDetails.yml +++ b/.mock/definition/crm/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/crm/accountToken.yml b/.mock/definition/crm/accountToken.yml index f06c40c5..a47b83c3 100644 --- a/.mock/definition/crm/accountToken.yml +++ b/.mock/definition/crm/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/crm/accounts.yml b/.mock/definition/crm/accounts.yml index e2959115..2e936825 100644 --- a/.mock/definition/crm/accounts.yml +++ b/.mock/definition/crm/accounts.yml @@ -80,7 +80,10 @@ service: type: root.PaginatedAccountList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -153,7 +156,8 @@ service: type: root.CrmAccountResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -258,7 +262,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae @@ -334,7 +339,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -416,7 +422,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -600,7 +607,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -826,7 +834,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -837,6 +848,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/associationTypes.yml b/.mock/definition/crm/associationTypes.yml index 01f582d6..44da88c3 100644 --- a/.mock/definition/crm/associationTypes.yml +++ b/.mock/definition/crm/associationTypes.yml @@ -73,7 +73,10 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -124,7 +127,8 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: source_object_class: @@ -208,7 +212,8 @@ service: - path-parameters: custom_object_class_id: custom_object_class_id id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 5bb73c32-3c6c-4757-ab7d-7d3540a1be31 @@ -244,7 +249,8 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/crm/associations.yml b/.mock/definition/crm/associations.yml index bf27f3eb..983b55fe 100644 --- a/.mock/definition/crm/associations.yml +++ b/.mock/definition/crm/associations.yml @@ -81,7 +81,10 @@ service: - path-parameters: custom_object_class_id: custom_object_class_id object_id: object_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -130,7 +133,8 @@ service: source_object_id: source_object_id target_class_id: target_class_id target_object_id: target_object_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: created_at: '2021-09-15T00:00:00Z' diff --git a/.mock/definition/crm/asyncPassthrough.yml b/.mock/definition/crm/asyncPassthrough.yml index 6a7e257e..2fc106c9 100644 --- a/.mock/definition/crm/asyncPassthrough.yml +++ b/.mock/definition/crm/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/crm/auditTrail.yml b/.mock/definition/crm/auditTrail.yml index 68ad5c2f..be883e26 100644 --- a/.mock/definition/crm/auditTrail.yml +++ b/.mock/definition/crm/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/crm/availableActions.yml b/.mock/definition/crm/availableActions.yml index 40338033..71b5d890 100644 --- a/.mock/definition/crm/availableActions.yml +++ b/.mock/definition/crm/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/crm/contacts.yml b/.mock/definition/crm/contacts.yml index b9f0b0f0..3fbcf9cd 100644 --- a/.mock/definition/crm/contacts.yml +++ b/.mock/definition/crm/contacts.yml @@ -104,7 +104,10 @@ service: type: root.PaginatedContactList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -179,7 +182,8 @@ service: type: root.CrmContactResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -286,7 +290,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -364,7 +369,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -451,7 +457,8 @@ service: examples: - path-parameters: model_id: model_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: reason: GENERAL_CUSTOMER_REQUEST metaPatchRetrieve: @@ -470,7 +477,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -654,7 +662,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -880,7 +889,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -891,6 +903,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/customObjectClasses.yml b/.mock/definition/crm/customObjectClasses.yml index 7f6a5fba..87b54cad 100644 --- a/.mock/definition/crm/customObjectClasses.yml +++ b/.mock/definition/crm/customObjectClasses.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedCustomObjectClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -146,7 +149,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: ff1ff4cb-a66b-47dc-8e2a-50388049e602 diff --git a/.mock/definition/crm/customObjects.yml b/.mock/definition/crm/customObjects.yml index d4904e56..275d59c9 100644 --- a/.mock/definition/crm/customObjects.yml +++ b/.mock/definition/crm/customObjects.yml @@ -73,7 +73,10 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -121,7 +124,8 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: fields: @@ -197,7 +201,8 @@ service: - path-parameters: custom_object_class_id: custom_object_class_id id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: da0b1963-be70-469c-9f8c-06a81d0fe759 @@ -230,7 +235,8 @@ service: examples: - path-parameters: custom_object_class_id: custom_object_class_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -456,7 +462,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -467,6 +476,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/deleteAccount.yml b/.mock/definition/crm/deleteAccount.yml index b0bfe1cd..9a343bd8 100644 --- a/.mock/definition/crm/deleteAccount.yml +++ b/.mock/definition/crm/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/crm/engagementTypes.yml b/.mock/definition/crm/engagementTypes.yml index 2070b2ef..025fe8e8 100644 --- a/.mock/definition/crm/engagementTypes.yml +++ b/.mock/definition/crm/engagementTypes.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedEngagementTypeList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -117,7 +120,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -184,7 +188,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -195,6 +202,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/engagements.yml b/.mock/definition/crm/engagements.yml index aaf88ac0..0812685b 100644 --- a/.mock/definition/crm/engagements.yml +++ b/.mock/definition/crm/engagements.yml @@ -145,7 +145,10 @@ service: type: root.PaginatedEngagementList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -204,7 +207,8 @@ service: type: root.EngagementResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -295,7 +299,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -357,7 +362,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -425,7 +431,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -609,7 +616,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -835,7 +843,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -846,6 +857,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/fieldMapping.yml b/.mock/definition/crm/fieldMapping.yml index 5318dcf3..81c29c9c 100644 --- a/.mock/definition/crm/fieldMapping.yml +++ b/.mock/definition/crm/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: @@ -245,7 +246,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -312,7 +314,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -394,7 +397,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -465,7 +469,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: @@ -611,7 +616,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Account: diff --git a/.mock/definition/crm/forceResync.yml b/.mock/definition/crm/forceResync.yml index eb74ba18..32a995cb 100644 --- a/.mock/definition/crm/forceResync.yml +++ b/.mock/definition/crm/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Account diff --git a/.mock/definition/crm/generateKey.yml b/.mock/definition/crm/generateKey.yml index 233479da..c913f239 100644 --- a/.mock/definition/crm/generateKey.yml +++ b/.mock/definition/crm/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/crm/issues.yml b/.mock/definition/crm/issues.yml index ed21c69c..85deddd4 100644 --- a/.mock/definition/crm/issues.yml +++ b/.mock/definition/crm/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/crm/leads.yml b/.mock/definition/crm/leads.yml index 1f1e46d1..f6cc37af 100644 --- a/.mock/definition/crm/leads.yml +++ b/.mock/definition/crm/leads.yml @@ -124,7 +124,10 @@ service: type: root.PaginatedLeadList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -204,7 +207,8 @@ service: type: root.LeadResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -316,7 +320,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -380,7 +385,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -606,7 +612,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -617,6 +626,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/linkToken.yml b/.mock/definition/crm/linkToken.yml index f67b6892..d01d1d24 100644 --- a/.mock/definition/crm/linkToken.yml +++ b/.mock/definition/crm/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/crm/linkedAccounts.yml b/.mock/definition/crm/linkedAccounts.yml index c6f4399e..d2bf12d2 100644 --- a/.mock/definition/crm/linkedAccounts.yml +++ b/.mock/definition/crm/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/crm/notes.yml b/.mock/definition/crm/notes.yml index df9293aa..ac7d94d1 100644 --- a/.mock/definition/crm/notes.yml +++ b/.mock/definition/crm/notes.yml @@ -147,7 +147,10 @@ service: type: root.PaginatedNoteList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -203,7 +206,8 @@ service: type: root.NoteResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -291,7 +295,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -331,7 +336,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -557,7 +563,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -568,6 +577,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/opportunities.yml b/.mock/definition/crm/opportunities.yml index 4a0253aa..3aaaa4d0 100644 --- a/.mock/definition/crm/opportunities.yml +++ b/.mock/definition/crm/opportunities.yml @@ -148,7 +148,10 @@ service: type: root.PaginatedOpportunityList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -207,7 +210,8 @@ service: type: root.OpportunityResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -308,7 +312,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -370,7 +375,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -438,7 +444,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -622,7 +629,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -848,7 +856,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -859,6 +870,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/passthrough.yml b/.mock/definition/crm/passthrough.yml index 902b459d..a0a04015 100644 --- a/.mock/definition/crm/passthrough.yml +++ b/.mock/definition/crm/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/crm/regenerateKey.yml b/.mock/definition/crm/regenerateKey.yml index 06a1b856..d807b273 100644 --- a/.mock/definition/crm/regenerateKey.yml +++ b/.mock/definition/crm/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/crm/scopes.yml b/.mock/definition/crm/scopes.yml index 67286e70..7069f300 100644 --- a/.mock/definition/crm/scopes.yml +++ b/.mock/definition/crm/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/crm/stages.yml b/.mock/definition/crm/stages.yml index a8676fa5..126f73c6 100644 --- a/.mock/definition/crm/stages.yml +++ b/.mock/definition/crm/stages.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedStageList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -126,7 +129,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0358cbc6-2040-430a-848e-aafacbadf3aa @@ -202,7 +206,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -213,6 +220,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/syncStatus.yml b/.mock/definition/crm/syncStatus.yml index 52d8c36e..8e3a610c 100644 --- a/.mock/definition/crm/syncStatus.yml +++ b/.mock/definition/crm/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/crm/tasks.yml b/.mock/definition/crm/tasks.yml index befb0c54..e5b9f3b8 100644 --- a/.mock/definition/crm/tasks.yml +++ b/.mock/definition/crm/tasks.yml @@ -105,7 +105,10 @@ service: type: root.PaginatedTaskList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -162,7 +165,8 @@ service: type: root.TaskResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -251,7 +255,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 550e8400-e29b-41d4-a716-446655440000 @@ -311,7 +316,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -377,7 +383,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -561,7 +568,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -787,7 +795,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -798,6 +809,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/users.yml b/.mock/definition/crm/users.yml index 6762984a..ba9863c8 100644 --- a/.mock/definition/crm/users.yml +++ b/.mock/definition/crm/users.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedUserList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -131,7 +134,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0358cbc6-2040-430a-848e-aafacbadf3aa @@ -174,7 +178,8 @@ service: examples: - path-parameters: model_id: model_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: reason: GENERAL_CUSTOMER_REQUEST remoteFieldClassesList: @@ -231,7 +236,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -242,6 +250,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/webhookReceivers.yml b/.mock/definition/crm/webhookReceivers.yml index c68cd98b..e01c1645 100644 --- a/.mock/definition/crm/webhookReceivers.yml +++ b/.mock/definition/crm/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/filestorage/__package__.yml b/.mock/definition/filestorage/__package__.yml index 16d7bfbc..11c8d1e7 100644 --- a/.mock/definition/filestorage/__package__.yml +++ b/.mock/definition/filestorage/__package__.yml @@ -48,6 +48,22 @@ types: docs: The time at which account completes the linking flow. source: openapi: openapi/openapi.yml + AccountDetailsAndActionsCategory: + discriminated: false + union: + - CategoryEnum + - string + source: + openapi: openapi/openapi.yml + inline: true + AccountDetailsAndActionsStatus: + discriminated: false + union: + - AccountDetailsAndActionsStatusEnum + - string + source: + openapi: openapi/openapi.yml + inline: true AccountDetailsAndActions: docs: >- # The LinkedAccount Object @@ -63,8 +79,8 @@ types: View a list of your organization's `LinkedAccount` objects. properties: id: string - category: optional - status: AccountDetailsAndActionsStatusEnum + category: optional + status: AccountDetailsAndActionsStatus status_detail: optional end_user_origin_id: optional end_user_organization_name: string @@ -2243,6 +2259,14 @@ types: source: openapi: openapi/openapi.yml inline: true + SyncStatusStatus: + discriminated: false + union: + - StatusFd5Enum + - string + source: + openapi: openapi/openapi.yml + inline: true SyncStatus: docs: >- # The SyncStatus Object @@ -2264,7 +2288,7 @@ types: next_sync_start: optional last_sync_result: optional last_sync_finished: optional - status: StatusFd5Enum + status: SyncStatusStatus is_initial_sync: boolean selective_sync_configurations_usage: optional source: diff --git a/.mock/definition/filestorage/accountDetails.yml b/.mock/definition/filestorage/accountDetails.yml index 2411f37c..944a422b 100644 --- a/.mock/definition/filestorage/accountDetails.yml +++ b/.mock/definition/filestorage/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/filestorage/accountToken.yml b/.mock/definition/filestorage/accountToken.yml index 2c17a04f..e5400279 100644 --- a/.mock/definition/filestorage/accountToken.yml +++ b/.mock/definition/filestorage/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/filestorage/asyncPassthrough.yml b/.mock/definition/filestorage/asyncPassthrough.yml index 58df8351..1408e056 100644 --- a/.mock/definition/filestorage/asyncPassthrough.yml +++ b/.mock/definition/filestorage/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/filestorage/auditTrail.yml b/.mock/definition/filestorage/auditTrail.yml index f21c35fe..c9fb17ce 100644 --- a/.mock/definition/filestorage/auditTrail.yml +++ b/.mock/definition/filestorage/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/filestorage/availableActions.yml b/.mock/definition/filestorage/availableActions.yml index b7a5e2b1..b60bd0c8 100644 --- a/.mock/definition/filestorage/availableActions.yml +++ b/.mock/definition/filestorage/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/filestorage/deleteAccount.yml b/.mock/definition/filestorage/deleteAccount.yml index 9b691154..cb9280c2 100644 --- a/.mock/definition/filestorage/deleteAccount.yml +++ b/.mock/definition/filestorage/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/filestorage/drives.yml b/.mock/definition/filestorage/drives.yml index 969b2321..8053831f 100644 --- a/.mock/definition/filestorage/drives.yml +++ b/.mock/definition/filestorage/drives.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedDriveList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -121,7 +124,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: f9e3d315-d6c2-458e-85c4-fa773d6ff4a6 diff --git a/.mock/definition/filestorage/fieldMapping.yml b/.mock/definition/filestorage/fieldMapping.yml index 0ef97a18..73378990 100644 --- a/.mock/definition/filestorage/fieldMapping.yml +++ b/.mock/definition/filestorage/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: File: @@ -181,7 +182,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -248,7 +250,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -330,7 +333,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -401,7 +405,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: File: @@ -491,7 +496,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: File: diff --git a/.mock/definition/filestorage/files.yml b/.mock/definition/filestorage/files.yml index 7230424d..97b56cde 100644 --- a/.mock/definition/filestorage/files.yml +++ b/.mock/definition/filestorage/files.yml @@ -150,7 +150,10 @@ service: type: root.PaginatedFileList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -215,7 +218,8 @@ service: type: root.FileStorageFileResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -307,7 +311,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 45ce474c-dhcj-43a6-754r-629f799f7d68 @@ -401,7 +406,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 @@ -473,7 +479,10 @@ service: type: root.PaginatedDownloadRequestMetaList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -496,7 +505,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/filestorage/folders.yml b/.mock/definition/filestorage/folders.yml index 50ad205b..5ad69d06 100644 --- a/.mock/definition/filestorage/folders.yml +++ b/.mock/definition/filestorage/folders.yml @@ -113,7 +113,10 @@ service: type: root.PaginatedFolderList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -169,7 +172,8 @@ service: type: root.FileStorageFolderResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -252,7 +256,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: e021f7a7-74fc-4487-8e12-14180c92d3b7 @@ -290,7 +295,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/filestorage/forceResync.yml b/.mock/definition/filestorage/forceResync.yml index 644c49b8..6dc20ca9 100644 --- a/.mock/definition/filestorage/forceResync.yml +++ b/.mock/definition/filestorage/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: File diff --git a/.mock/definition/filestorage/generateKey.yml b/.mock/definition/filestorage/generateKey.yml index 04ac41b8..06b1c8d7 100644 --- a/.mock/definition/filestorage/generateKey.yml +++ b/.mock/definition/filestorage/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/filestorage/groups.yml b/.mock/definition/filestorage/groups.yml index 247ce30a..75e3efbd 100644 --- a/.mock/definition/filestorage/groups.yml +++ b/.mock/definition/filestorage/groups.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedGroupList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -128,7 +131,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 5624aceb-0ea2-4864-ba08-354ac56b9884 diff --git a/.mock/definition/filestorage/issues.yml b/.mock/definition/filestorage/issues.yml index b6a1d19e..19a40bd9 100644 --- a/.mock/definition/filestorage/issues.yml +++ b/.mock/definition/filestorage/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/filestorage/linkToken.yml b/.mock/definition/filestorage/linkToken.yml index fda54a0c..180619c3 100644 --- a/.mock/definition/filestorage/linkToken.yml +++ b/.mock/definition/filestorage/linkToken.yml @@ -1,5 +1,22 @@ imports: root: __package__.yml +types: + EndUserDetailsRequestLanguage: + discriminated: false + docs: >- + The following subset of IETF language tags can be used to configure + localization. + + + * `en` - en + + * `de` - de + union: + - root.LanguageEnum + - string + source: + openapi: openapi/openapi.yml + inline: true service: auth: false base-path: '' @@ -93,7 +110,7 @@ service: linked. Any model or field not specified in link token payload will default to existing settings. language: - type: optional + type: optional docs: >- The following subset of IETF language tags can be used to configure localization. @@ -119,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/filestorage/linkedAccounts.yml b/.mock/definition/filestorage/linkedAccounts.yml index d8fb0eb6..3c656510 100644 --- a/.mock/definition/filestorage/linkedAccounts.yml +++ b/.mock/definition/filestorage/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/filestorage/passthrough.yml b/.mock/definition/filestorage/passthrough.yml index 432034bc..71b42437 100644 --- a/.mock/definition/filestorage/passthrough.yml +++ b/.mock/definition/filestorage/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/filestorage/regenerateKey.yml b/.mock/definition/filestorage/regenerateKey.yml index cd80f783..b251851a 100644 --- a/.mock/definition/filestorage/regenerateKey.yml +++ b/.mock/definition/filestorage/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/filestorage/scopes.yml b/.mock/definition/filestorage/scopes.yml index a48a1642..b6b40f3e 100644 --- a/.mock/definition/filestorage/scopes.yml +++ b/.mock/definition/filestorage/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/filestorage/syncStatus.yml b/.mock/definition/filestorage/syncStatus.yml index 53140e4d..a35bc7c6 100644 --- a/.mock/definition/filestorage/syncStatus.yml +++ b/.mock/definition/filestorage/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/filestorage/users.yml b/.mock/definition/filestorage/users.yml index 6921bd65..38b7714c 100644 --- a/.mock/definition/filestorage/users.yml +++ b/.mock/definition/filestorage/users.yml @@ -67,7 +67,10 @@ service: type: root.PaginatedUserList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -119,7 +122,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 83902e75-4362-4803-b76c-a7d6be292cbd diff --git a/.mock/definition/filestorage/webhookReceivers.yml b/.mock/definition/filestorage/webhookReceivers.yml index 3b0bcace..6b965003 100644 --- a/.mock/definition/filestorage/webhookReceivers.yml +++ b/.mock/definition/filestorage/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/hris/__package__.yml b/.mock/definition/hris/__package__.yml index 3e17db3f..95d44358 100644 --- a/.mock/definition/hris/__package__.yml +++ b/.mock/definition/hris/__package__.yml @@ -64,6 +64,14 @@ types: source: openapi: openapi/openapi.yml inline: true + AccountDetailsAndActionsStatus: + discriminated: false + union: + - AccountDetailsAndActionsStatusEnum + - string + source: + openapi: openapi/openapi.yml + inline: true AccountDetailsAndActions: docs: >- # The LinkedAccount Object @@ -80,7 +88,7 @@ types: properties: id: string category: optional - status: AccountDetailsAndActionsStatusEnum + status: AccountDetailsAndActionsStatus status_detail: optional end_user_origin_id: optional end_user_organization_name: string @@ -689,6 +697,11 @@ types: end_date: type: optional docs: The day and time the benefit ended. + employer_benefit: + type: optional + docs: The employer benefit plan the employee is enrolled in. + validation: + format: uuid remote_was_deleted: type: optional docs: >- @@ -698,11 +711,6 @@ types: [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). access: read-only - employer_benefit: - type: optional - docs: The employer benefit plan the employee is enrolled in. - validation: - format: uuid field_mappings: type: optional> access: read-only @@ -6942,6 +6950,14 @@ types: source: openapi: openapi/openapi.yml inline: true + SyncStatusStatus: + discriminated: false + union: + - StatusFd5Enum + - string + source: + openapi: openapi/openapi.yml + inline: true SyncStatus: docs: >- # The SyncStatus Object @@ -6963,7 +6979,7 @@ types: next_sync_start: optional last_sync_result: optional last_sync_finished: optional - status: StatusFd5Enum + status: SyncStatusStatus is_initial_sync: boolean selective_sync_configurations_usage: optional source: diff --git a/.mock/definition/hris/accountDetails.yml b/.mock/definition/hris/accountDetails.yml index 2d4833d3..140409e5 100644 --- a/.mock/definition/hris/accountDetails.yml +++ b/.mock/definition/hris/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/hris/accountToken.yml b/.mock/definition/hris/accountToken.yml index 84185ffb..022851f2 100644 --- a/.mock/definition/hris/accountToken.yml +++ b/.mock/definition/hris/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/hris/asyncPassthrough.yml b/.mock/definition/hris/asyncPassthrough.yml index 841c4d91..9cb0b941 100644 --- a/.mock/definition/hris/asyncPassthrough.yml +++ b/.mock/definition/hris/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/hris/auditTrail.yml b/.mock/definition/hris/auditTrail.yml index 19e653ea..684b7e5d 100644 --- a/.mock/definition/hris/auditTrail.yml +++ b/.mock/definition/hris/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/hris/availableActions.yml b/.mock/definition/hris/availableActions.yml index 74b6e655..e03e84f2 100644 --- a/.mock/definition/hris/availableActions.yml +++ b/.mock/definition/hris/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/hris/bankInfo.yml b/.mock/definition/hris/bankInfo.yml index d8d8fc21..872097f9 100644 --- a/.mock/definition/hris/bankInfo.yml +++ b/.mock/definition/hris/bankInfo.yml @@ -115,7 +115,10 @@ service: type: root.PaginatedBankInfoList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -185,7 +188,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d diff --git a/.mock/definition/hris/benefits.yml b/.mock/definition/hris/benefits.yml index 2a98a378..2802723b 100644 --- a/.mock/definition/hris/benefits.yml +++ b/.mock/definition/hris/benefits.yml @@ -74,7 +74,10 @@ service: type: root.PaginatedBenefitList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -86,13 +89,12 @@ service: modified_at: '2021-10-16T00:00:00Z' employee: employee provider_name: Blue Shield of California - benefit_plan_type: benefit_plan_type employee_contribution: 23.65 company_contribution: 150 start_date: '2020-11-15T00:59:25Z' end_date: '2021-10-15T00:23:25Z' - remote_was_deleted: true employer_benefit: 025fjlc6-6000-430a-848e-aafacbadf4fe + remote_was_deleted: true field_mappings: organization_defined_targets: custom_key: custom_value @@ -136,7 +138,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 3fe5ae7a-f1ba-4529-b7af-84e86dc6d232 @@ -145,13 +148,12 @@ service: modified_at: '2021-10-16T00:00:00Z' employee: employee provider_name: Blue Shield of California - benefit_plan_type: benefit_plan_type employee_contribution: 23.65 company_contribution: 150 start_date: '2020-11-15T00:59:25Z' end_date: '2021-10-15T00:23:25Z' - remote_was_deleted: true employer_benefit: 025fjlc6-6000-430a-848e-aafacbadf4fe + remote_was_deleted: true field_mappings: organization_defined_targets: custom_key: custom_value diff --git a/.mock/definition/hris/companies.yml b/.mock/definition/hris/companies.yml index 3b107952..cb3881df 100644 --- a/.mock/definition/hris/companies.yml +++ b/.mock/definition/hris/companies.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedCompanyList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -119,7 +122,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 1b998423-db0a-4037-a4cf-f79c60cb67b3 diff --git a/.mock/definition/hris/deleteAccount.yml b/.mock/definition/hris/deleteAccount.yml index d8b1e45c..fb59bf5f 100644 --- a/.mock/definition/hris/deleteAccount.yml +++ b/.mock/definition/hris/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/hris/dependents.yml b/.mock/definition/hris/dependents.yml index a4254ddd..bab4360c 100644 --- a/.mock/definition/hris/dependents.yml +++ b/.mock/definition/hris/dependents.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedDependentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -134,7 +137,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 025fjlc6-6000-430a-848e-aafacbadf4fe diff --git a/.mock/definition/hris/employeePayrollRuns.yml b/.mock/definition/hris/employeePayrollRuns.yml index c4ffb0b9..f6f53b28 100644 --- a/.mock/definition/hris/employeePayrollRuns.yml +++ b/.mock/definition/hris/employeePayrollRuns.yml @@ -116,7 +116,10 @@ service: type: root.PaginatedEmployeePayrollRunList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -206,7 +209,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fb8c55b6-1cb8-4b4c-9fb6-17924231619d diff --git a/.mock/definition/hris/employees.yml b/.mock/definition/hris/employees.yml index bd50cfa6..df2cd00f 100644 --- a/.mock/definition/hris/employees.yml +++ b/.mock/definition/hris/employees.yml @@ -1320,7 +1320,10 @@ service: type: root.PaginatedEmployeeList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1347,14 +1350,12 @@ service: home_location: home_location work_location: work_location manager: manager - team: team pay_group: pay_group ssn: '1234567890' gender: MALE ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE marital_status: SINGLE date_of_birth: '1990-11-10T00:00:00Z' - hire_date: '2020-10-10T00:00:00Z' start_date: '2020-10-11T00:00:00Z' remote_created_at: '2020-10-11T00:00:00Z' employment_status: ACTIVE @@ -1399,7 +1400,8 @@ service: type: root.EmployeeResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -1426,14 +1428,12 @@ service: home_location: home_location work_location: work_location manager: manager - team: team pay_group: pay_group ssn: '1234567890' gender: MALE ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE marital_status: SINGLE date_of_birth: '1990-11-10T00:00:00Z' - hire_date: '2020-10-10T00:00:00Z' start_date: '2020-10-11T00:00:00Z' remote_created_at: '2020-10-11T00:00:00Z' employment_status: ACTIVE @@ -1520,7 +1520,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae @@ -1544,14 +1545,12 @@ service: home_location: home_location work_location: work_location manager: manager - team: team pay_group: pay_group ssn: '1234567890' gender: MALE ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE marital_status: SINGLE date_of_birth: '1990-11-10T00:00:00Z' - hire_date: '2020-10-10T00:00:00Z' start_date: '2020-10-11T00:00:00Z' remote_created_at: '2020-10-11T00:00:00Z' employment_status: ACTIVE @@ -1596,7 +1595,8 @@ service: examples: - path-parameters: model_id: model_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: reason: GENERAL_CUSTOMER_REQUEST metaPostRetrieve: @@ -1611,7 +1611,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/hris/employerBenefits.yml b/.mock/definition/hris/employerBenefits.yml index f110617f..c8b0023c 100644 --- a/.mock/definition/hris/employerBenefits.yml +++ b/.mock/definition/hris/employerBenefits.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedEmployerBenefitList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -115,7 +118,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 025fjlc6-6000-430a-848e-aafacbadf4fele diff --git a/.mock/definition/hris/employments.yml b/.mock/definition/hris/employments.yml index f676c7df..d653306f 100644 --- a/.mock/definition/hris/employments.yml +++ b/.mock/definition/hris/employments.yml @@ -232,7 +232,10 @@ service: type: root.PaginatedEmploymentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -306,7 +309,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982 diff --git a/.mock/definition/hris/fieldMapping.yml b/.mock/definition/hris/fieldMapping.yml index 2c83b146..1a222f9f 100644 --- a/.mock/definition/hris/fieldMapping.yml +++ b/.mock/definition/hris/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Benefit: @@ -357,7 +358,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -424,7 +426,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -506,7 +509,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -577,7 +581,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Benefit: @@ -821,7 +826,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Benefit: diff --git a/.mock/definition/hris/forceResync.yml b/.mock/definition/hris/forceResync.yml index ccae8e7b..3871daeb 100644 --- a/.mock/definition/hris/forceResync.yml +++ b/.mock/definition/hris/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Employee diff --git a/.mock/definition/hris/generateKey.yml b/.mock/definition/hris/generateKey.yml index 94a399fc..18c4f7c3 100644 --- a/.mock/definition/hris/generateKey.yml +++ b/.mock/definition/hris/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/hris/groups.yml b/.mock/definition/hris/groups.yml index 942ebedf..a9bc5589 100644 --- a/.mock/definition/hris/groups.yml +++ b/.mock/definition/hris/groups.yml @@ -91,7 +91,10 @@ service: type: root.PaginatedGroupList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -154,7 +157,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 134e0111-0f67-44f6-98f0-597000290bb3 diff --git a/.mock/definition/hris/issues.yml b/.mock/definition/hris/issues.yml index 9fd39ae2..d9de5306 100644 --- a/.mock/definition/hris/issues.yml +++ b/.mock/definition/hris/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/hris/linkToken.yml b/.mock/definition/hris/linkToken.yml index c83a57e8..766171de 100644 --- a/.mock/definition/hris/linkToken.yml +++ b/.mock/definition/hris/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/hris/linkedAccounts.yml b/.mock/definition/hris/linkedAccounts.yml index 3ed63936..5d4c897d 100644 --- a/.mock/definition/hris/linkedAccounts.yml +++ b/.mock/definition/hris/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/hris/locations.yml b/.mock/definition/hris/locations.yml index a4c2f9b6..d5217222 100644 --- a/.mock/definition/hris/locations.yml +++ b/.mock/definition/hris/locations.yml @@ -120,7 +120,10 @@ service: type: root.PaginatedLocationList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -188,7 +191,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: f5e6a151-f44e-449a-afb1-8fd781905958 diff --git a/.mock/definition/hris/passthrough.yml b/.mock/definition/hris/passthrough.yml index 602b2cd6..fbe19301 100644 --- a/.mock/definition/hris/passthrough.yml +++ b/.mock/definition/hris/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/hris/payGroups.yml b/.mock/definition/hris/payGroups.yml index 981803d8..dd031706 100644 --- a/.mock/definition/hris/payGroups.yml +++ b/.mock/definition/hris/payGroups.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedPayGroupList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -114,7 +117,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d diff --git a/.mock/definition/hris/payrollRuns.yml b/.mock/definition/hris/payrollRuns.yml index b4414e43..8687f6d5 100644 --- a/.mock/definition/hris/payrollRuns.yml +++ b/.mock/definition/hris/payrollRuns.yml @@ -153,7 +153,10 @@ service: type: root.PaginatedPayrollRunList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -217,7 +220,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 37336947-b3d4-4a4c-a310-ab6ab510e079 diff --git a/.mock/definition/hris/regenerateKey.yml b/.mock/definition/hris/regenerateKey.yml index e29e77d3..b9daa8b2 100644 --- a/.mock/definition/hris/regenerateKey.yml +++ b/.mock/definition/hris/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/hris/scopes.yml b/.mock/definition/hris/scopes.yml index 59ec6a77..31252ad4 100644 --- a/.mock/definition/hris/scopes.yml +++ b/.mock/definition/hris/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/hris/syncStatus.yml b/.mock/definition/hris/syncStatus.yml index c7e03e66..cca7aca2 100644 --- a/.mock/definition/hris/syncStatus.yml +++ b/.mock/definition/hris/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/hris/teams.yml b/.mock/definition/hris/teams.yml index 4cb87414..902b49a3 100644 --- a/.mock/definition/hris/teams.yml +++ b/.mock/definition/hris/teams.yml @@ -72,7 +72,10 @@ service: type: root.PaginatedTeamList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -128,7 +131,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 13a72919-9fae-4f54-81ca-ddfd8712a1ba diff --git a/.mock/definition/hris/timeOff.yml b/.mock/definition/hris/timeOff.yml index 94818112..6ed9b785 100644 --- a/.mock/definition/hris/timeOff.yml +++ b/.mock/definition/hris/timeOff.yml @@ -236,7 +236,10 @@ service: type: root.PaginatedTimeOffList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -292,7 +295,8 @@ service: type: root.TimeOffResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -385,7 +389,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 91b2b905-e866-40c8-8be2-efe53827a0aa @@ -423,7 +428,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/hris/timeOffBalances.yml b/.mock/definition/hris/timeOffBalances.yml index 509df361..22ad8176 100644 --- a/.mock/definition/hris/timeOffBalances.yml +++ b/.mock/definition/hris/timeOffBalances.yml @@ -112,7 +112,10 @@ service: type: root.PaginatedTimeOffBalanceList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -180,7 +183,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 91b2b905-e866-40c8-8be2-efe53827a0aa diff --git a/.mock/definition/hris/timesheetEntries.yml b/.mock/definition/hris/timesheetEntries.yml index 69380ef4..62f53265 100644 --- a/.mock/definition/hris/timesheetEntries.yml +++ b/.mock/definition/hris/timesheetEntries.yml @@ -106,7 +106,10 @@ service: type: root.PaginatedTimesheetEntryList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -157,7 +160,8 @@ service: type: root.TimesheetEntryResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -235,7 +239,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 91b2b905-e866-40c8-8be2-efe53827a0aa @@ -268,7 +273,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/hris/webhookReceivers.yml b/.mock/definition/hris/webhookReceivers.yml index 05eae39d..62fbcab5 100644 --- a/.mock/definition/hris/webhookReceivers.yml +++ b/.mock/definition/hris/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/definition/ticketing/__package__.yml b/.mock/definition/ticketing/__package__.yml index fef97a5f..9d24f443 100644 --- a/.mock/definition/ticketing/__package__.yml +++ b/.mock/definition/ticketing/__package__.yml @@ -2117,9 +2117,6 @@ types: * `COLLECTION` - COLLECTION tags: optional>> roles: optional>> - completed_at: - type: optional - docs: When the ticket was completed. ticket_url: type: optional docs: The 3rd party url of the Ticket. @@ -2135,6 +2132,9 @@ types: * `HIGH` - HIGH * `NORMAL` - NORMAL * `LOW` - LOW + completed_at: + type: optional + docs: When the ticket was completed. integration_params: type: optional> access: write-only @@ -2319,6 +2319,7 @@ types: remote_key_name: optional description: optional is_custom: optional + is_common_model_field: optional is_required: optional field_type: optional field_format: optional @@ -2422,8 +2423,8 @@ types: * `ASSIGNED_ONLY` - ASSIGNED_ONLY * `TEAM_ONLY` - TEAM_ONLY union: - - string - TicketAccessEnum + - string source: openapi: openapi/openapi.yml inline: true @@ -2541,6 +2542,14 @@ types: source: openapi: openapi/openapi.yml inline: true + SyncStatusStatus: + discriminated: false + union: + - StatusFd5Enum + - string + source: + openapi: openapi/openapi.yml + inline: true SyncStatus: docs: >- # The SyncStatus Object @@ -2562,7 +2571,7 @@ types: next_sync_start: optional last_sync_result: optional last_sync_finished: optional - status: StatusFd5Enum + status: SyncStatusStatus is_initial_sync: boolean selective_sync_configurations_usage: optional source: @@ -2894,6 +2903,21 @@ types: * `COLLECTION` - COLLECTION tags: optional>> roles: optional>> + ticket_url: + type: optional + docs: The 3rd party url of the Ticket. + validation: + format: uri + maxLength: 2000 + priority: + type: optional + docs: |- + The priority or urgency of the Ticket. + + * `URGENT` - URGENT + * `HIGH` - HIGH + * `NORMAL` - NORMAL + * `LOW` - LOW remote_created_at: type: optional docs: When the third party's ticket was created. @@ -2912,21 +2936,6 @@ types: [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). access: read-only - ticket_url: - type: optional - docs: The 3rd party url of the Ticket. - validation: - format: uri - maxLength: 2000 - priority: - type: optional - docs: |- - The priority or urgency of the Ticket. - - * `URGENT` - URGENT - * `HIGH` - HIGH - * `NORMAL` - NORMAL - * `LOW` - LOW field_mappings: type: optional> access: read-only @@ -3194,9 +3203,6 @@ types: * `COLLECTION` - COLLECTION tags: optional>> roles: optional>> - completed_at: - type: optional - docs: When the ticket was completed. ticket_url: type: optional docs: The 3rd party url of the Ticket. @@ -3212,6 +3218,9 @@ types: * `HIGH` - HIGH * `NORMAL` - NORMAL * `LOW` - LOW + completed_at: + type: optional + docs: When the ticket was completed. integration_params: type: optional> access: write-only diff --git a/.mock/definition/ticketing/accountDetails.yml b/.mock/definition/ticketing/accountDetails.yml index 1cd26dd4..4204619f 100644 --- a/.mock/definition/ticketing/accountDetails.yml +++ b/.mock/definition/ticketing/accountDetails.yml @@ -16,7 +16,8 @@ service: type: root.AccountDetails status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd diff --git a/.mock/definition/ticketing/accountToken.yml b/.mock/definition/ticketing/accountToken.yml index e3b505e5..057dc6d6 100644 --- a/.mock/definition/ticketing/accountToken.yml +++ b/.mock/definition/ticketing/accountToken.yml @@ -22,6 +22,8 @@ service: examples: - path-parameters: public_token: public_token + headers: + X-Account-Token: '[object Object]' response: body: account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB diff --git a/.mock/definition/ticketing/accounts.yml b/.mock/definition/ticketing/accounts.yml index 9dc3f7a8..4f695f73 100644 --- a/.mock/definition/ticketing/accounts.yml +++ b/.mock/definition/ticketing/accounts.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedAccountList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -117,7 +120,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 diff --git a/.mock/definition/ticketing/asyncPassthrough.yml b/.mock/definition/ticketing/asyncPassthrough.yml index 0a2001fe..02724e93 100644 --- a/.mock/definition/ticketing/asyncPassthrough.yml +++ b/.mock/definition/ticketing/asyncPassthrough.yml @@ -21,7 +21,8 @@ service: type: root.AsyncPassthroughReciept status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters @@ -44,7 +45,8 @@ service: examples: - path-parameters: async_passthrough_receipt_id: async_passthrough_receipt_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: method: GET diff --git a/.mock/definition/ticketing/attachments.yml b/.mock/definition/ticketing/attachments.yml index 9a8a8a9c..671474bf 100644 --- a/.mock/definition/ticketing/attachments.yml +++ b/.mock/definition/ticketing/attachments.yml @@ -77,7 +77,10 @@ service: type: root.PaginatedAttachmentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -128,7 +131,8 @@ service: type: root.TicketingAttachmentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -206,7 +210,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 @@ -270,7 +275,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ticketing/auditTrail.yml b/.mock/definition/ticketing/auditTrail.yml index 82660fae..5b42e8b8 100644 --- a/.mock/definition/ticketing/auditTrail.yml +++ b/.mock/definition/ticketing/auditTrail.yml @@ -75,7 +75,11 @@ service: type: root.PaginatedAuditLogEventList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/ticketing/availableActions.yml b/.mock/definition/ticketing/availableActions.yml index 745b76c7..750b5faa 100644 --- a/.mock/definition/ticketing/availableActions.yml +++ b/.mock/definition/ticketing/availableActions.yml @@ -16,7 +16,8 @@ service: type: root.AvailableActions status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: integration: diff --git a/.mock/definition/ticketing/collections.yml b/.mock/definition/ticketing/collections.yml index dbf6f131..0861c825 100644 --- a/.mock/definition/ticketing/collections.yml +++ b/.mock/definition/ticketing/collections.yml @@ -87,7 +87,10 @@ service: type: root.PaginatedCollectionList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -162,7 +165,10 @@ service: examples: - path-parameters: collection_id: collection_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -218,7 +224,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fb8c55b6-1cb8-4b4c-9fb6-17924231619d diff --git a/.mock/definition/ticketing/comments.yml b/.mock/definition/ticketing/comments.yml index 71a70dc5..7c789021 100644 --- a/.mock/definition/ticketing/comments.yml +++ b/.mock/definition/ticketing/comments.yml @@ -108,7 +108,10 @@ service: type: root.PaginatedCommentList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -164,7 +167,8 @@ service: type: root.CommentResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -247,7 +251,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae @@ -285,7 +290,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ticketing/contacts.yml b/.mock/definition/ticketing/contacts.yml index e4a13d7c..6bc83943 100644 --- a/.mock/definition/ticketing/contacts.yml +++ b/.mock/definition/ticketing/contacts.yml @@ -69,7 +69,10 @@ service: type: root.PaginatedContactList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -119,7 +122,8 @@ service: type: root.TicketingContactResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -196,7 +200,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 @@ -230,7 +235,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: diff --git a/.mock/definition/ticketing/deleteAccount.yml b/.mock/definition/ticketing/deleteAccount.yml index b2d1911d..021acbde 100644 --- a/.mock/definition/ticketing/deleteAccount.yml +++ b/.mock/definition/ticketing/deleteAccount.yml @@ -10,6 +10,7 @@ service: source: openapi: openapi/openapi.yml examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token source: openapi: openapi/openapi.yml diff --git a/.mock/definition/ticketing/fieldMapping.yml b/.mock/definition/ticketing/fieldMapping.yml index 3051c3fc..8721c1c2 100644 --- a/.mock/definition/ticketing/fieldMapping.yml +++ b/.mock/definition/ticketing/fieldMapping.yml @@ -30,7 +30,8 @@ service: type: root.FieldMappingApiInstanceResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Ticket: @@ -277,7 +278,8 @@ service: type: root.FieldMappingInstanceResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: target_field_name: example_target_field_name target_field_description: this is a example description of the target field @@ -344,7 +346,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: model: @@ -426,7 +429,8 @@ service: examples: - path-parameters: field_mapping_id: field_mapping_id - headers: {} + headers: + X-Account-Token: X-Account-Token request: {} response: body: @@ -497,7 +501,8 @@ service: type: root.RemoteFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Ticket: @@ -671,7 +676,8 @@ service: type: root.ExternalTargetFieldApiResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: Ticket: diff --git a/.mock/definition/ticketing/forceResync.yml b/.mock/definition/ticketing/forceResync.yml index a9669fa2..39b44277 100644 --- a/.mock/definition/ticketing/forceResync.yml +++ b/.mock/definition/ticketing/forceResync.yml @@ -21,7 +21,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - model_name: Ticket diff --git a/.mock/definition/ticketing/generateKey.yml b/.mock/definition/ticketing/generateKey.yml index 54e7585c..03e42e8e 100644 --- a/.mock/definition/ticketing/generateKey.yml +++ b/.mock/definition/ticketing/generateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/ticketing/issues.yml b/.mock/definition/ticketing/issues.yml index badd03c1..22c452d4 100644 --- a/.mock/definition/ticketing/issues.yml +++ b/.mock/definition/ticketing/issues.yml @@ -80,7 +80,11 @@ service: type: root.PaginatedIssueList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ @@ -112,6 +116,8 @@ service: examples: - path-parameters: id: id + headers: + X-Account-Token: '[object Object]' response: body: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 diff --git a/.mock/definition/ticketing/linkToken.yml b/.mock/definition/ticketing/linkToken.yml index 908ed584..b3c79737 100644 --- a/.mock/definition/ticketing/linkToken.yml +++ b/.mock/definition/ticketing/linkToken.yml @@ -136,7 +136,9 @@ service: type: root.LinkToken status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: end_user_email_address: example@gmail.com end_user_organization_name: Test Organization end_user_origin_id: '12345' diff --git a/.mock/definition/ticketing/linkedAccounts.yml b/.mock/definition/ticketing/linkedAccounts.yml index 072cf0e3..a9563978 100644 --- a/.mock/definition/ticketing/linkedAccounts.yml +++ b/.mock/definition/ticketing/linkedAccounts.yml @@ -107,7 +107,11 @@ service: type: root.PaginatedAccountDetailsAndActionsList status-code: 200 examples: - - response: + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: '[object Object]' + response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ diff --git a/.mock/definition/ticketing/passthrough.yml b/.mock/definition/ticketing/passthrough.yml index 44434d15..f20522bf 100644 --- a/.mock/definition/ticketing/passthrough.yml +++ b/.mock/definition/ticketing/passthrough.yml @@ -19,7 +19,8 @@ service: type: root.RemoteResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: method: GET path: /scooters diff --git a/.mock/definition/ticketing/projects.yml b/.mock/definition/ticketing/projects.yml index dd749346..7623e288 100644 --- a/.mock/definition/ticketing/projects.yml +++ b/.mock/definition/ticketing/projects.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedProjectList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -113,7 +116,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: fb8c55b6-1cb8-4b4c-9fb6-17924231619d @@ -180,7 +184,10 @@ service: examples: - path-parameters: parent_id: parent_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ticketing/regenerateKey.yml b/.mock/definition/ticketing/regenerateKey.yml index 5dab779d..1697dc88 100644 --- a/.mock/definition/ticketing/regenerateKey.yml +++ b/.mock/definition/ticketing/regenerateKey.yml @@ -26,7 +26,9 @@ service: type: root.RemoteKey status-code: 200 examples: - - request: + - headers: + X-Account-Token: '[object Object]' + request: name: Remote Deployment Key 1 response: body: diff --git a/.mock/definition/ticketing/roles.yml b/.mock/definition/ticketing/roles.yml index 09eb4680..229d52a3 100644 --- a/.mock/definition/ticketing/roles.yml +++ b/.mock/definition/ticketing/roles.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedRoleList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -79,7 +82,7 @@ service: - VIEW - EDIT - CREATE - ticket_access: ticket_access + ticket_access: ALL remote_was_deleted: true field_mappings: organization_defined_targets: @@ -117,7 +120,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 23454124-387f-494d-265e-345b330c9123 @@ -129,7 +133,7 @@ service: - VIEW - EDIT - CREATE - ticket_access: ticket_access + ticket_access: ALL remote_was_deleted: true field_mappings: organization_defined_targets: diff --git a/.mock/definition/ticketing/scopes.yml b/.mock/definition/ticketing/scopes.yml index 11866654..61201cbf 100644 --- a/.mock/definition/ticketing/scopes.yml +++ b/.mock/definition/ticketing/scopes.yml @@ -19,7 +19,9 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - response: + - headers: + X-Account-Token: '[object Object]' + response: body: common_models: - model_name: Employee @@ -60,7 +62,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: common_models: @@ -111,7 +114,8 @@ service: type: root.CommonModelScopeApi status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: common_models: - model_name: Employee diff --git a/.mock/definition/ticketing/syncStatus.yml b/.mock/definition/ticketing/syncStatus.yml index 5b49f2a3..5cc91fe7 100644 --- a/.mock/definition/ticketing/syncStatus.yml +++ b/.mock/definition/ticketing/syncStatus.yml @@ -36,7 +36,10 @@ service: type: root.PaginatedSyncStatusList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/ticketing/tags.yml b/.mock/definition/ticketing/tags.yml index 7ebaf157..d8046d5f 100644 --- a/.mock/definition/ticketing/tags.yml +++ b/.mock/definition/ticketing/tags.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedTagList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -112,7 +115,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: remote_id: '19202938' diff --git a/.mock/definition/ticketing/teams.yml b/.mock/definition/ticketing/teams.yml index 47bcb682..0f6096db 100644 --- a/.mock/definition/ticketing/teams.yml +++ b/.mock/definition/ticketing/teams.yml @@ -64,7 +64,10 @@ service: type: root.PaginatedTeamList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -113,7 +116,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 diff --git a/.mock/definition/ticketing/tickets.yml b/.mock/definition/ticketing/tickets.yml index 8177b0bf..c166e3c5 100644 --- a/.mock/definition/ticketing/tickets.yml +++ b/.mock/definition/ticketing/tickets.yml @@ -1276,7 +1276,10 @@ service: type: root.PaginatedTicketList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1313,12 +1316,12 @@ service: roles: - 21a54124-397f-494d-985e-3c5b330b8a68 - 17a54124-287f-494d-965e-3c5b330c9a68 + ticket_url: https://thirdpartysoftware.com/project/3/issue/1 + priority: URGENT remote_created_at: '2021-11-10T00:00:00Z' remote_updated_at: '2021-12-09T00:00:00Z' completed_at: '2021-12-09T00:00:00Z' remote_was_deleted: true - ticket_url: https://thirdpartysoftware.com/project/3/issue/1 - priority: URGENT field_mappings: organization_defined_targets: custom_key: custom_value @@ -1355,7 +1358,8 @@ service: type: root.TicketResponse status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -1392,12 +1396,12 @@ service: roles: - 21a54124-397f-494d-985e-3c5b330b8a68 - 17a54124-287f-494d-965e-3c5b330c9a68 + ticket_url: https://thirdpartysoftware.com/project/3/issue/1 + priority: URGENT remote_created_at: '2021-11-10T00:00:00Z' remote_updated_at: '2021-12-09T00:00:00Z' completed_at: '2021-12-09T00:00:00Z' remote_was_deleted: true - ticket_url: https://thirdpartysoftware.com/project/3/issue/1 - priority: URGENT field_mappings: organization_defined_targets: custom_key: custom_value @@ -1476,7 +1480,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 0958cbc6-6040-430a-848e-aafacbadf4ae @@ -1510,12 +1515,12 @@ service: roles: - 21a54124-397f-494d-985e-3c5b330b8a68 - 17a54124-287f-494d-965e-3c5b330c9a68 + ticket_url: https://thirdpartysoftware.com/project/3/issue/1 + priority: URGENT remote_created_at: '2021-11-10T00:00:00Z' remote_updated_at: '2021-12-09T00:00:00Z' completed_at: '2021-12-09T00:00:00Z' remote_was_deleted: true - ticket_url: https://thirdpartysoftware.com/project/3/issue/1 - priority: URGENT field_mappings: organization_defined_targets: custom_key: custom_value @@ -1560,7 +1565,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token request: model: {} response: @@ -1597,12 +1603,12 @@ service: roles: - 21a54124-397f-494d-985e-3c5b330b8a68 - 17a54124-287f-494d-965e-3c5b330c9a68 + ticket_url: https://thirdpartysoftware.com/project/3/issue/1 + priority: URGENT remote_created_at: '2021-11-10T00:00:00Z' remote_updated_at: '2021-12-09T00:00:00Z' completed_at: '2021-12-09T00:00:00Z' remote_was_deleted: true - ticket_url: https://thirdpartysoftware.com/project/3/issue/1 - priority: URGENT field_mappings: organization_defined_targets: custom_key: custom_value @@ -1684,7 +1690,10 @@ service: examples: - path-parameters: ticket_id: ticket_id - headers: {} + query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -1712,7 +1721,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -1905,7 +1915,8 @@ service: type: root.MetaResponse status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: request_schema: @@ -2131,7 +2142,10 @@ service: type: root.PaginatedRemoteFieldClassList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -2142,6 +2156,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: field_type field_format: field_format diff --git a/.mock/definition/ticketing/users.yml b/.mock/definition/ticketing/users.yml index 76cfbe5f..05094917 100644 --- a/.mock/definition/ticketing/users.yml +++ b/.mock/definition/ticketing/users.yml @@ -94,7 +94,10 @@ service: type: root.PaginatedUserList status-code: 200 examples: - - headers: {} + - query-parameters: + cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + headers: + X-Account-Token: X-Account-Token response: body: next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw @@ -155,7 +158,8 @@ service: examples: - path-parameters: id: id - headers: {} + headers: + X-Account-Token: X-Account-Token response: body: id: 17a54124-287f-494d-965e-3c5b330c9a68 diff --git a/.mock/definition/ticketing/webhookReceivers.yml b/.mock/definition/ticketing/webhookReceivers.yml index 54b5126a..454c1a98 100644 --- a/.mock/definition/ticketing/webhookReceivers.yml +++ b/.mock/definition/ticketing/webhookReceivers.yml @@ -16,7 +16,8 @@ service: type: list status-code: 200 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token response: body: - event: event @@ -48,7 +49,8 @@ service: type: root.WebhookReceiver status-code: 201 examples: - - headers: {} + - headers: + X-Account-Token: X-Account-Token request: event: event is_active: true diff --git a/.mock/fern.config.json b/.mock/fern.config.json index c4faf103..43adf15e 100644 --- a/.mock/fern.config.json +++ b/.mock/fern.config.json @@ -1,4 +1,4 @@ { "organization" : "merge", - "version" : "0.63.28" + "version" : "0.66.29" } \ No newline at end of file diff --git a/README.md b/README.md index f61bfd79..7d4df116 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fmerge-api%2Fmerge-python-client) [![pypi](https://img.shields.io/pypi/v/MergePythonClient)](https://pypi.python.org/pypi/MergePythonClient) -The Merge Python library provides convenient access to the Merge API from Python. +The Merge Python library provides convenient access to the Merge APIs from Python. ## Documentation @@ -230,3 +230,4 @@ while response.next is not None: ``` + diff --git a/poetry.lock b/poetry.lock index c1c2313e..c2ddd863 100644 --- a/poetry.lock +++ b/poetry.lock @@ -38,13 +38,13 @@ trio = ["trio (>=0.26.1)"] [[package]] name = "certifi" -version = "2025.7.14" +version = "2025.8.3" description = "Python package for providing Mozilla's CA Bundle." optional = false python-versions = ">=3.7" files = [ - {file = "certifi-2025.7.14-py3-none-any.whl", hash = "sha256:6b31f564a415d79ee77df69d757bb49a5bb53bd9f756cbbe24394ffd6fc1f4b2"}, - {file = "certifi-2025.7.14.tar.gz", hash = "sha256:8ea99dbdfaaf2ba2f9bac77b9249ef62ec5218e7c2b2e903378ed5fccf765995"}, + {file = "certifi-2025.8.3-py3-none-any.whl", hash = "sha256:f6c12493cfb1b06ba2ff328595af9350c65d6644968e5d3a2ffd78699af217a5"}, + {file = "certifi-2025.8.3.tar.gz", hash = "sha256:e564105f78ded564e3ae7c923924435e1daa7463faeab5bb932bc53ffae63407"}, ] [[package]] diff --git a/pyproject.toml b/pyproject.toml index 88939876..ee7c8ba6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "MergePythonClient" [tool.poetry] name = "MergePythonClient" -version = "2.1.1" +version = "2.2.1" description = "" readme = "README.md" authors = [] diff --git a/reference.md b/reference.md index a497d5bf..cc3f222f 100644 --- a/reference.md +++ b/reference.md @@ -167,7 +167,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.list() +client.ats.activities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -610,7 +612,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.list() +client.ats.applications.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -1322,7 +1326,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.attachments.list() +client.ats.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -1765,7 +1771,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.audit_trail.list() +client.ats.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -1937,7 +1945,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.list() +client.ats.candidates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -2923,7 +2933,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.departments.list() +client.ats.departments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -3152,7 +3164,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.eeocs.list() +client.ats.eeocs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -4007,7 +4021,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.interviews.list() +client.ats.interviews.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -4474,7 +4490,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.issues.list() +client.ats.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -4724,7 +4742,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_interview_stages.list() +client.ats.job_interview_stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -4977,7 +4997,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_postings.list() +client.ats.job_postings.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -5238,7 +5260,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.jobs.list() +client.ats.jobs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -5548,6 +5572,7 @@ client = Merge( ) client.ats.jobs.screening_questions_list( job_id="job_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -5850,7 +5875,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.linked_accounts.list() +client.ats.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -6026,7 +6053,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.offers.list() +client.ats.offers.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -6319,7 +6348,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.offices.list() +client.ats.offices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -6696,7 +6727,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.reject_reasons.list() +client.ats.reject_reasons.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -6925,7 +6958,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.scorecards.list() +client.ats.scorecards.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -7226,7 +7261,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.sync_status.list() +client.ats.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -7366,7 +7403,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.tags.list() +client.ats.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -7508,7 +7547,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.users.list() +client.ats.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -8061,7 +8102,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.list() +client.crm.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -8654,7 +8697,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.remote_field_classes_list() +client.crm.accounts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -8927,7 +8972,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.audit_trail.list() +client.crm.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -9099,7 +9146,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.list() +client.crm.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -9783,7 +9832,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.remote_field_classes_list() +client.crm.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -9909,7 +9960,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.list() +client.crm.custom_object_classes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -10156,6 +10209,7 @@ client = Merge( ) client.crm.association_types.custom_object_classes_association_types_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -10604,6 +10658,7 @@ client = Merge( ) client.crm.custom_objects.custom_object_classes_custom_objects_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -11035,7 +11090,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list() +client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -11164,6 +11221,7 @@ client = Merge( client.crm.associations.custom_object_classes_custom_objects_associations_list( custom_object_class_id="custom_object_class_id", object_id="object_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -11746,7 +11804,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.list() +client.crm.engagement_types.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -11990,7 +12050,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.remote_field_classes_list() +client.crm.engagement_types.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -12116,7 +12178,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.list() +client.crm.engagements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -12709,7 +12773,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.remote_field_classes_list() +client.crm.engagements.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -13405,7 +13471,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.list() +client.crm.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -13655,7 +13723,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.list() +client.crm.leads.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -14104,7 +14174,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.remote_field_classes_list() +client.crm.leads.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -14414,7 +14486,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.linked_accounts.list() +client.crm.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -14590,7 +14664,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.list() +client.crm.notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -15031,7 +15107,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.remote_field_classes_list() +client.crm.notes.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -15157,7 +15235,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.list() +client.crm.opportunities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -15812,7 +15892,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.remote_field_classes_list() +client.crm.opportunities.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -16086,7 +16168,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.list() +client.crm.stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -16330,7 +16414,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.remote_field_classes_list() +client.crm.stages.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -16456,7 +16542,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.sync_status.list() +client.crm.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -16596,7 +16684,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.list() +client.crm.tasks.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -17173,7 +17263,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.remote_field_classes_list() +client.crm.tasks.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -17299,7 +17391,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.list() +client.crm.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -17634,7 +17728,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.remote_field_classes_list() +client.crm.users.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -18191,7 +18287,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.audit_trail.list() +client.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -18648,7 +18746,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.list() +client.filestorage.drives.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -19383,7 +19483,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.list() +client.filestorage.files.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -19834,7 +19936,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_list() +client.filestorage.files.download_request_meta_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -20029,7 +20133,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.list() +client.filestorage.folders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -20519,7 +20625,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.list() +client.filestorage.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -20764,7 +20872,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.list() +client.filestorage.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -21123,7 +21233,7 @@ client.filestorage.link_token.create(
-**language:** `typing.Optional[LanguageEnum]` +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` The following subset of IETF language tags can be used to configure localization. @@ -21198,7 +21308,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.linked_accounts.list() +client.filestorage.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ```
@@ -21522,7 +21634,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.sync_status.list() +client.filestorage.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -21662,7 +21776,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.list() +client.filestorage.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -22330,7 +22446,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.audit_trail.list() +client.hris.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -22502,7 +22620,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.list() +client.hris.bank_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -22816,7 +22936,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.list() +client.hris.benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -23069,7 +23191,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.list() +client.hris.companies.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -23583,7 +23707,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.dependents.list() +client.hris.dependents.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -23828,7 +23954,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.list() +client.hris.employee_payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -24121,7 +24249,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.list() +client.hris.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -24810,7 +24940,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.list() +client.hris.employer_benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -25039,7 +25171,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.list() +client.hris.employments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -25902,7 +26036,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.list() +client.hris.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -26187,7 +26323,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.list() +client.hris.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -26621,7 +26759,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.linked_accounts.list() +client.hris.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -26797,7 +26937,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.list() +client.hris.locations.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -27147,7 +27289,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.list() +client.hris.pay_groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -27376,7 +27520,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.list() +client.hris.payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -27757,7 +27903,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.sync_status.list() +client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -27897,7 +28045,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.list() +client.hris.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -28150,7 +28300,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.list() +client.hris.time_off.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -28657,7 +28809,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.list() +client.hris.time_off_balances.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -28959,7 +29113,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.list() +client.hris.timesheet_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -29685,7 +29841,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.list() +client.ticketing.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -30061,7 +30219,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.list() +client.ticketing.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -30471,7 +30631,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.audit_trail.list() +client.ticketing.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -30643,7 +30805,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.list() +client.ticketing.collections.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -30826,6 +30990,7 @@ client = Merge( ) client.ticketing.collections.viewers_list( collection_id="collection_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -31055,7 +31220,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.list() +client.ticketing.comments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -31465,7 +31632,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.list() +client.ticketing.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -32714,7 +32883,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.list() +client.ticketing.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -33148,7 +33319,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.linked_accounts.list() +client.ticketing.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -33400,7 +33573,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.list() +client.ticketing.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -33630,6 +33805,7 @@ client = Merge( ) client.ticketing.projects.users_list( parent_id="parent_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -33820,7 +33996,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.list() +client.ticketing.roles.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -34049,7 +34227,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.sync_status.list() +client.ticketing.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -34189,7 +34369,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.list() +client.ticketing.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -34418,7 +34600,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.teams.list() +client.ticketing.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -34647,7 +34831,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.list() +client.ticketing.tickets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -35277,6 +35463,7 @@ client = Merge( ) client.ticketing.tickets.viewers_list( ticket_id="ticket_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -35542,7 +35729,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.remote_field_classes_list() +client.ticketing.tickets.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -35668,7 +35857,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.list() +client.ticketing.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -36213,7 +36404,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.accounting_periods.list() +client.accounting.accounting_periods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -36402,7 +36595,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.accounts.list() +client.accounting.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -37191,7 +37386,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.attachments.list() +client.accounting.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -37577,7 +37774,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.audit_trail.list() +client.accounting.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -37749,7 +37948,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.balance_sheets.list() +client.accounting.balance_sheets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -38002,7 +38203,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.bank_feed_accounts.list() +client.accounting.bank_feed_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -38340,7 +38543,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.bank_feed_transactions.list() +client.accounting.bank_feed_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -38742,7 +38947,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.cash_flow_statements.list() +client.accounting.cash_flow_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -38995,7 +39202,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.company_info.list() +client.accounting.company_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -39240,7 +39449,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.contacts.list() +client.accounting.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -39729,7 +39940,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.contacts.remote_field_classes_list() +client.accounting.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -39847,7 +40060,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.credit_notes.list() +client.accounting.credit_notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -40582,7 +40797,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.employees.list() +client.accounting.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -40835,7 +41052,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expense_reports.list() +client.accounting.expense_reports.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -41095,6 +41314,7 @@ client = Merge( ) client.accounting.expense_reports.lines_list( expense_report_id="expense_report_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -41323,7 +41543,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expense_reports.lines_remote_field_classes_list() +client.accounting.expense_reports.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -41501,7 +41723,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expense_reports.remote_field_classes_list() +client.accounting.expense_reports.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -41619,7 +41843,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expenses.list() +client.accounting.expenses.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -41991,7 +42217,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expenses.lines_remote_field_classes_list() +client.accounting.expenses.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -42169,7 +42397,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.expenses.remote_field_classes_list() +client.accounting.expenses.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -42785,7 +43015,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.general_ledger_transactions.list() +client.accounting.general_ledger_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -43126,7 +43358,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.income_statements.list() +client.accounting.income_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -43379,7 +43613,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.invoices.list() +client.accounting.invoices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -43928,7 +44164,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.invoices.line_items_remote_field_classes_list() +client.accounting.invoices.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -44177,7 +44415,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.invoices.remote_field_classes_list() +client.accounting.invoices.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -44295,7 +44535,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.issues.list() +client.accounting.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -44545,7 +44787,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.items.list() +client.accounting.items.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -45147,7 +45391,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.journal_entries.list() +client.accounting.journal_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -45519,7 +45765,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.journal_entries.lines_remote_field_classes_list() +client.accounting.journal_entries.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -45697,7 +45945,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.journal_entries.remote_field_classes_list() +client.accounting.journal_entries.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -45999,7 +46249,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.linked_accounts.list() +client.accounting.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -46251,7 +46503,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payment_methods.list() +client.accounting.payment_methods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -46440,7 +46694,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payment_terms.list() +client.accounting.payment_terms.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -46645,7 +46901,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payments.list() +client.accounting.payments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -47130,7 +47388,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payments.line_items_remote_field_classes_list() +client.accounting.payments.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -47379,7 +47639,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.payments.remote_field_classes_list() +client.accounting.payments.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -47585,7 +47847,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.projects.list() +client.accounting.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -47838,7 +48102,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.purchase_orders.list() +client.accounting.purchase_orders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -48242,7 +48508,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.purchase_orders.line_items_remote_field_classes_list() +client.accounting.purchase_orders.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -48420,7 +48688,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.purchase_orders.remote_field_classes_list() +client.accounting.purchase_orders.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -48610,7 +48880,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.sync_status.list() +client.accounting.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -48750,7 +49022,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.tax_rates.list() +client.accounting.tax_rates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -49011,7 +49285,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.tracking_categories.list() +client.accounting.tracking_categories.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -49320,7 +49596,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.transactions.list() +client.accounting.transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -49589,7 +49867,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.accounting.vendor_credits.list() +client.accounting.vendor_credits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` diff --git a/src/merge/core/client_wrapper.py b/src/merge/core/client_wrapper.py index 955b5565..671b0562 100644 --- a/src/merge/core/client_wrapper.py +++ b/src/merge/core/client_wrapper.py @@ -24,10 +24,10 @@ def __init__( def get_headers(self) -> typing.Dict[str, str]: headers: typing.Dict[str, str] = { - "User-Agent": "MergePythonClient/2.1.1", + "User-Agent": "MergePythonClient/2.2.1", "X-Fern-Language": "Python", "X-Fern-SDK-Name": "MergePythonClient", - "X-Fern-SDK-Version": "2.1.1", + "X-Fern-SDK-Version": "2.2.1", **(self.get_custom_headers() or {}), } if self._account_token is not None: diff --git a/src/merge/core/force_multipart.py b/src/merge/core/force_multipart.py index ae24ccff..5440913f 100644 --- a/src/merge/core/force_multipart.py +++ b/src/merge/core/force_multipart.py @@ -1,7 +1,9 @@ # This file was auto-generated by Fern from our API Definition. +from typing import Any, Dict -class ForceMultipartDict(dict): + +class ForceMultipartDict(Dict[str, Any]): """ A dictionary subclass that always evaluates to True in boolean contexts. @@ -9,7 +11,7 @@ class ForceMultipartDict(dict): the dictionary is empty, which would normally evaluate to False. """ - def __bool__(self): + def __bool__(self) -> bool: return True diff --git a/src/merge/core/http_response.py b/src/merge/core/http_response.py index 48a1798a..2479747e 100644 --- a/src/merge/core/http_response.py +++ b/src/merge/core/http_response.py @@ -4,8 +4,8 @@ import httpx +# Generic to represent the underlying type of the data wrapped by the HTTP response. T = TypeVar("T") -"""Generic to represent the underlying type of the data wrapped by the HTTP response.""" class BaseHttpResponse: diff --git a/src/merge/core/unchecked_base_model.py b/src/merge/core/unchecked_base_model.py index e04a6f81..ae59845f 100644 --- a/src/merge/core/unchecked_base_model.py +++ b/src/merge/core/unchecked_base_model.py @@ -186,7 +186,7 @@ def _convert_undiscriminated_union_type(union_type: typing.Type[typing.Any], obj def _convert_union_type(type_: typing.Type[typing.Any], object_: typing.Any) -> typing.Any: base_type = get_origin(type_) or type_ union_type = type_ - if base_type == typing_extensions.Annotated: + if base_type == typing_extensions.Annotated: # type: ignore[comparison-overlap] union_type = get_args(type_)[0] annotated_metadata = get_args(type_)[1:] for metadata in annotated_metadata: @@ -217,11 +217,11 @@ def construct_type(*, type_: typing.Type[typing.Any], object_: typing.Any) -> ty return None base_type = get_origin(type_) or type_ - is_annotated = base_type == typing_extensions.Annotated + is_annotated = base_type == typing_extensions.Annotated # type: ignore[comparison-overlap] maybe_annotation_members = get_args(type_) is_annotated_union = is_annotated and is_union(get_origin(maybe_annotation_members[0])) - if base_type == typing.Any: + if base_type == typing.Any: # type: ignore[comparison-overlap] return object_ if base_type == dict: diff --git a/src/merge/resources/accounting/__init__.py b/src/merge/resources/accounting/__init__.py index ce637e34..b8b80e4c 100644 --- a/src/merge/resources/accounting/__init__.py +++ b/src/merge/resources/accounting/__init__.py @@ -19,7 +19,6 @@ AccountRequest, AccountRequestAccountType, AccountRequestClassification, - AccountRequestCurrency, AccountRequestStatus, AccountResponse, AccountStatus, @@ -71,7 +70,6 @@ BankFeedTransactionResponse, CashFlowStatement, CashFlowStatementCompany, - CashFlowStatementCurrency, CategoriesEnum, CategoryEnum, CategoryTypeEnum, @@ -164,7 +162,9 @@ ExpenseLineTrackingCategoriesItem, ExpenseLineTrackingCategory, ExpenseReport, + ExpenseReportAccountingPeriod, ExpenseReportCompany, + ExpenseReportEmployee, ExpenseReportLine, ExpenseReportLineAccount, ExpenseReportLineCompany, @@ -183,6 +183,7 @@ ExpenseReportRequestAccountingPeriod, ExpenseReportRequestCompany, ExpenseReportRequestEmployee, + ExpenseReportRequestStatus, ExpenseReportResponse, ExpenseReportStatus, ExpenseReportStatusEnum, @@ -379,7 +380,6 @@ PatchedPaymentRequestAccount, PatchedPaymentRequestAccountingPeriod, PatchedPaymentRequestAppliedToLinesItem, - PatchedPaymentRequestCompany, PatchedPaymentRequestContact, PatchedPaymentRequestCurrency, PatchedPaymentRequestPaymentMethod, @@ -431,7 +431,6 @@ PurchaseOrderPaymentTerm, PurchaseOrderRequest, PurchaseOrderRequestCompany, - PurchaseOrderRequestCurrency, PurchaseOrderRequestDeliveryAddress, PurchaseOrderRequestPaymentTerm, PurchaseOrderRequestStatus, @@ -463,6 +462,7 @@ Status895Enum, StatusFd5Enum, SyncStatus, + SyncStatusLastSyncResult, SyncStatusStatus, TaxComponent, TaxComponentComponentType, @@ -477,6 +477,7 @@ Transaction, TransactionAccount, TransactionAccountingPeriod, + TransactionCompany, TransactionContact, TransactionCurrency, TransactionCurrencyEnum, @@ -505,6 +506,7 @@ VendorCreditLineRequestAccount, VendorCreditLineRequestContact, VendorCreditLineRequestProject, + VendorCreditLinesItem, VendorCreditRequest, VendorCreditRequestAccountingPeriod, VendorCreditRequestCompany, @@ -627,7 +629,6 @@ "AccountRequest", "AccountRequestAccountType", "AccountRequestClassification", - "AccountRequestCurrency", "AccountRequestStatus", "AccountResponse", "AccountStatus", @@ -684,7 +685,6 @@ "BankFeedTransactionResponse", "CashFlowStatement", "CashFlowStatementCompany", - "CashFlowStatementCurrency", "CategoriesEnum", "CategoryEnum", "CategoryTypeEnum", @@ -788,7 +788,9 @@ "ExpenseLineTrackingCategoriesItem", "ExpenseLineTrackingCategory", "ExpenseReport", + "ExpenseReportAccountingPeriod", "ExpenseReportCompany", + "ExpenseReportEmployee", "ExpenseReportLine", "ExpenseReportLineAccount", "ExpenseReportLineCompany", @@ -807,6 +809,7 @@ "ExpenseReportRequestAccountingPeriod", "ExpenseReportRequestCompany", "ExpenseReportRequestEmployee", + "ExpenseReportRequestStatus", "ExpenseReportResponse", "ExpenseReportStatus", "ExpenseReportStatusEnum", @@ -1020,7 +1023,6 @@ "PatchedPaymentRequestAccount", "PatchedPaymentRequestAccountingPeriod", "PatchedPaymentRequestAppliedToLinesItem", - "PatchedPaymentRequestCompany", "PatchedPaymentRequestContact", "PatchedPaymentRequestCurrency", "PatchedPaymentRequestPaymentMethod", @@ -1076,7 +1078,6 @@ "PurchaseOrderPaymentTerm", "PurchaseOrderRequest", "PurchaseOrderRequestCompany", - "PurchaseOrderRequestCurrency", "PurchaseOrderRequestDeliveryAddress", "PurchaseOrderRequestPaymentTerm", "PurchaseOrderRequestStatus", @@ -1110,6 +1111,7 @@ "Status895Enum", "StatusFd5Enum", "SyncStatus", + "SyncStatusLastSyncResult", "SyncStatusStatus", "TaxComponent", "TaxComponentComponentType", @@ -1124,6 +1126,7 @@ "Transaction", "TransactionAccount", "TransactionAccountingPeriod", + "TransactionCompany", "TransactionContact", "TransactionCurrency", "TransactionCurrencyEnum", @@ -1154,6 +1157,7 @@ "VendorCreditLineRequestAccount", "VendorCreditLineRequestContact", "VendorCreditLineRequestProject", + "VendorCreditLinesItem", "VendorCreditRequest", "VendorCreditRequestAccountingPeriod", "VendorCreditRequestCompany", diff --git a/src/merge/resources/accounting/resources/accounting_periods/client.py b/src/merge/resources/accounting/resources/accounting_periods/client.py index 4008dfb9..ea3dd2a4 100644 --- a/src/merge/resources/accounting/resources/accounting_periods/client.py +++ b/src/merge/resources/accounting/resources/accounting_periods/client.py @@ -70,7 +70,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.accounting_periods.list() + client.accounting.accounting_periods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -198,7 +200,9 @@ async def list( async def main() -> None: - await client.accounting.accounting_periods.list() + await client.accounting.accounting_periods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/accounts/client.py b/src/merge/resources/accounting/resources/accounts/client.py index 66260f6f..2cd1cb34 100644 --- a/src/merge/resources/accounting/resources/accounts/client.py +++ b/src/merge/resources/accounting/resources/accounts/client.py @@ -133,7 +133,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.accounts.list() + client.accounting.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_type=account_type, @@ -415,7 +417,9 @@ async def list( async def main() -> None: - await client.accounting.accounts.list() + await client.accounting.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/attachments/client.py b/src/merge/resources/accounting/resources/attachments/client.py index 4cd8b43c..ca9a16a7 100644 --- a/src/merge/resources/accounting/resources/attachments/client.py +++ b/src/merge/resources/accounting/resources/attachments/client.py @@ -101,7 +101,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.attachments.list() + client.accounting.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -333,7 +335,9 @@ async def list( async def main() -> None: - await client.accounting.attachments.list() + await client.accounting.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/audit_trail/client.py b/src/merge/resources/accounting/resources/audit_trail/client.py index 6d0d1886..be175372 100644 --- a/src/merge/resources/accounting/resources/audit_trail/client.py +++ b/src/merge/resources/accounting/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.audit_trail.list() + client.accounting.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.accounting.audit_trail.list() + await client.accounting.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/balance_sheets/client.py b/src/merge/resources/accounting/resources/balance_sheets/client.py index 3f90d213..9f18736a 100644 --- a/src/merge/resources/accounting/resources/balance_sheets/client.py +++ b/src/merge/resources/accounting/resources/balance_sheets/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.balance_sheets.list() + client.accounting.balance_sheets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.accounting.balance_sheets.list() + await client.accounting.balance_sheets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/bank_feed_accounts/client.py b/src/merge/resources/accounting/resources/bank_feed_accounts/client.py index b1368bdf..0063c805 100644 --- a/src/merge/resources/accounting/resources/bank_feed_accounts/client.py +++ b/src/merge/resources/accounting/resources/bank_feed_accounts/client.py @@ -76,7 +76,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.bank_feed_accounts.list() + client.accounting.bank_feed_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -278,7 +280,9 @@ async def list( async def main() -> None: - await client.accounting.bank_feed_accounts.list() + await client.accounting.bank_feed_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/bank_feed_transactions/client.py b/src/merge/resources/accounting/resources/bank_feed_transactions/client.py index e8408b1d..5def8262 100644 --- a/src/merge/resources/accounting/resources/bank_feed_transactions/client.py +++ b/src/merge/resources/accounting/resources/bank_feed_transactions/client.py @@ -105,7 +105,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.bank_feed_transactions.list() + client.accounting.bank_feed_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -347,7 +349,9 @@ async def list( async def main() -> None: - await client.accounting.bank_feed_transactions.list() + await client.accounting.bank_feed_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/cash_flow_statements/client.py b/src/merge/resources/accounting/resources/cash_flow_statements/client.py index 59b2a40e..632235a4 100644 --- a/src/merge/resources/accounting/resources/cash_flow_statements/client.py +++ b/src/merge/resources/accounting/resources/cash_flow_statements/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.cash_flow_statements.list() + client.accounting.cash_flow_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.accounting.cash_flow_statements.list() + await client.accounting.cash_flow_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/company_info/client.py b/src/merge/resources/accounting/resources/company_info/client.py index 342b4fbc..a4a4fbc6 100644 --- a/src/merge/resources/accounting/resources/company_info/client.py +++ b/src/merge/resources/accounting/resources/company_info/client.py @@ -97,7 +97,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.company_info.list() + client.accounting.company_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -260,7 +262,9 @@ async def list( async def main() -> None: - await client.accounting.company_info.list() + await client.accounting.company_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/contacts/client.py b/src/merge/resources/accounting/resources/contacts/client.py index 6a425b25..66345884 100644 --- a/src/merge/resources/accounting/resources/contacts/client.py +++ b/src/merge/resources/accounting/resources/contacts/client.py @@ -140,7 +140,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.contacts.list() + client.accounting.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -364,7 +366,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.contacts.remote_field_classes_list() + client.accounting.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -505,7 +509,9 @@ async def list( async def main() -> None: - await client.accounting.contacts.list() + await client.accounting.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -761,7 +767,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.contacts.remote_field_classes_list() + await client.accounting.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/credit_notes/client.py b/src/merge/resources/accounting/resources/credit_notes/client.py index 91989aab..8b535864 100644 --- a/src/merge/resources/accounting/resources/credit_notes/client.py +++ b/src/merge/resources/accounting/resources/credit_notes/client.py @@ -127,7 +127,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.credit_notes.list() + client.accounting.credit_notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -399,7 +401,9 @@ async def list( async def main() -> None: - await client.accounting.credit_notes.list() + await client.accounting.credit_notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/employees/client.py b/src/merge/resources/accounting/resources/employees/client.py index eef0756f..73f4af0b 100644 --- a/src/merge/resources/accounting/resources/employees/client.py +++ b/src/merge/resources/accounting/resources/employees/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.employees.list() + client.accounting.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.accounting.employees.list() + await client.accounting.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/expense_reports/client.py b/src/merge/resources/accounting/resources/expense_reports/client.py index 2a30eb5f..0b2585d5 100644 --- a/src/merge/resources/accounting/resources/expense_reports/client.py +++ b/src/merge/resources/accounting/resources/expense_reports/client.py @@ -114,7 +114,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expense_reports.list() + client.accounting.expense_reports.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -245,6 +247,7 @@ def lines_list( ) client.accounting.expense_reports.lines_list( expense_report_id="expense_report_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.lines_list( @@ -373,7 +376,9 @@ def lines_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expense_reports.lines_remote_field_classes_list() + client.accounting.expense_reports.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.lines_remote_field_classes_list( cursor=cursor, @@ -468,7 +473,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expense_reports.remote_field_classes_list() + client.accounting.expense_reports.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -581,7 +588,9 @@ async def list( async def main() -> None: - await client.accounting.expense_reports.list() + await client.accounting.expense_reports.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -728,6 +737,7 @@ async def lines_list( async def main() -> None: await client.accounting.expense_reports.lines_list( expense_report_id="expense_report_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -872,7 +882,9 @@ async def lines_remote_field_classes_list( async def main() -> None: - await client.accounting.expense_reports.lines_remote_field_classes_list() + await client.accounting.expense_reports.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -983,7 +995,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.expense_reports.remote_field_classes_list() + await client.accounting.expense_reports.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/expenses/client.py b/src/merge/resources/accounting/resources/expenses/client.py index af655c88..c268fc18 100644 --- a/src/merge/resources/accounting/resources/expenses/client.py +++ b/src/merge/resources/accounting/resources/expenses/client.py @@ -120,7 +120,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expenses.list() + client.accounting.expenses.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -302,7 +304,9 @@ def lines_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expenses.lines_remote_field_classes_list() + client.accounting.expenses.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.lines_remote_field_classes_list( cursor=cursor, @@ -397,7 +401,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.expenses.remote_field_classes_list() + client.accounting.expenses.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -518,7 +524,9 @@ async def list( async def main() -> None: - await client.accounting.expenses.list() + await client.accounting.expenses.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -724,7 +732,9 @@ async def lines_remote_field_classes_list( async def main() -> None: - await client.accounting.expenses.lines_remote_field_classes_list() + await client.accounting.expenses.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -835,7 +845,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.expenses.remote_field_classes_list() + await client.accounting.expenses.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/general_ledger_transactions/client.py b/src/merge/resources/accounting/resources/general_ledger_transactions/client.py index a4f2eff3..77139d04 100644 --- a/src/merge/resources/accounting/resources/general_ledger_transactions/client.py +++ b/src/merge/resources/accounting/resources/general_ledger_transactions/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.general_ledger_transactions.list() + client.accounting.general_ledger_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -287,7 +289,9 @@ async def list( async def main() -> None: - await client.accounting.general_ledger_transactions.list() + await client.accounting.general_ledger_transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/income_statements/client.py b/src/merge/resources/accounting/resources/income_statements/client.py index 83d098da..79cd108f 100644 --- a/src/merge/resources/accounting/resources/income_statements/client.py +++ b/src/merge/resources/accounting/resources/income_statements/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.income_statements.list() + client.accounting.income_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.accounting.income_statements.list() + await client.accounting.income_statements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/invoices/client.py b/src/merge/resources/accounting/resources/invoices/client.py index d7cdb07f..f5a51718 100644 --- a/src/merge/resources/accounting/resources/invoices/client.py +++ b/src/merge/resources/accounting/resources/invoices/client.py @@ -156,7 +156,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.invoices.list() + client.accounting.invoices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -407,7 +409,9 @@ def line_items_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.invoices.line_items_remote_field_classes_list() + client.accounting.invoices.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.line_items_remote_field_classes_list( cursor=cursor, @@ -533,7 +537,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.invoices.remote_field_classes_list() + client.accounting.invoices.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -688,7 +694,9 @@ async def list( async def main() -> None: - await client.accounting.invoices.list() + await client.accounting.invoices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -971,7 +979,9 @@ async def line_items_remote_field_classes_list( async def main() -> None: - await client.accounting.invoices.line_items_remote_field_classes_list() + await client.accounting.invoices.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -1123,7 +1133,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.invoices.remote_field_classes_list() + await client.accounting.invoices.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/issues/client.py b/src/merge/resources/accounting/resources/issues/client.py index 68e0cc48..18eec115 100644 --- a/src/merge/resources/accounting/resources/issues/client.py +++ b/src/merge/resources/accounting/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.issues.list() + client.accounting.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.accounting.issues.list() + await client.accounting.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/items/client.py b/src/merge/resources/accounting/resources/items/client.py index 395dd3e7..e66fe427 100644 --- a/src/merge/resources/accounting/resources/items/client.py +++ b/src/merge/resources/accounting/resources/items/client.py @@ -116,7 +116,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.items.list() + client.accounting.items.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -460,7 +462,9 @@ async def list( async def main() -> None: - await client.accounting.items.list() + await client.accounting.items.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/journal_entries/client.py b/src/merge/resources/accounting/resources/journal_entries/client.py index f35ff8eb..1a7d47ed 100644 --- a/src/merge/resources/accounting/resources/journal_entries/client.py +++ b/src/merge/resources/accounting/resources/journal_entries/client.py @@ -120,7 +120,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.journal_entries.list() + client.accounting.journal_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -302,7 +304,9 @@ def lines_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.journal_entries.lines_remote_field_classes_list() + client.accounting.journal_entries.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.lines_remote_field_classes_list( cursor=cursor, @@ -397,7 +401,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.journal_entries.remote_field_classes_list() + client.accounting.journal_entries.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -518,7 +524,9 @@ async def list( async def main() -> None: - await client.accounting.journal_entries.list() + await client.accounting.journal_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -724,7 +732,9 @@ async def lines_remote_field_classes_list( async def main() -> None: - await client.accounting.journal_entries.lines_remote_field_classes_list() + await client.accounting.journal_entries.lines_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -835,7 +845,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.journal_entries.remote_field_classes_list() + await client.accounting.journal_entries.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/linked_accounts/client.py b/src/merge/resources/accounting/resources/linked_accounts/client.py index df102c2b..2a5024cd 100644 --- a/src/merge/resources/accounting/resources/linked_accounts/client.py +++ b/src/merge/resources/accounting/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.linked_accounts.list() + client.accounting.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.accounting.linked_accounts.list() + await client.accounting.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/payment_methods/client.py b/src/merge/resources/accounting/resources/payment_methods/client.py index ee070e4f..2b8226d6 100644 --- a/src/merge/resources/accounting/resources/payment_methods/client.py +++ b/src/merge/resources/accounting/resources/payment_methods/client.py @@ -70,7 +70,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payment_methods.list() + client.accounting.payment_methods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -198,7 +200,9 @@ async def list( async def main() -> None: - await client.accounting.payment_methods.list() + await client.accounting.payment_methods.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/payment_terms/client.py b/src/merge/resources/accounting/resources/payment_terms/client.py index 7de8f6a7..7f0e7f70 100644 --- a/src/merge/resources/accounting/resources/payment_terms/client.py +++ b/src/merge/resources/accounting/resources/payment_terms/client.py @@ -74,7 +74,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payment_terms.list() + client.accounting.payment_terms.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -212,7 +214,9 @@ async def list( async def main() -> None: - await client.accounting.payment_terms.list() + await client.accounting.payment_terms.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/payments/client.py b/src/merge/resources/accounting/resources/payments/client.py index 473acf56..c6fdbb43 100644 --- a/src/merge/resources/accounting/resources/payments/client.py +++ b/src/merge/resources/accounting/resources/payments/client.py @@ -129,7 +129,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payments.list() + client.accounting.payments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -364,7 +366,9 @@ def line_items_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payments.line_items_remote_field_classes_list() + client.accounting.payments.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.line_items_remote_field_classes_list( cursor=cursor, @@ -490,7 +494,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.payments.remote_field_classes_list() + client.accounting.payments.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -619,7 +625,9 @@ async def list( async def main() -> None: - await client.accounting.payments.list() + await client.accounting.payments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -886,7 +894,9 @@ async def line_items_remote_field_classes_list( async def main() -> None: - await client.accounting.payments.line_items_remote_field_classes_list() + await client.accounting.payments.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -1038,7 +1048,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.payments.remote_field_classes_list() + await client.accounting.payments.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/projects/client.py b/src/merge/resources/accounting/resources/projects/client.py index 4afffa7e..a7335b20 100644 --- a/src/merge/resources/accounting/resources/projects/client.py +++ b/src/merge/resources/accounting/resources/projects/client.py @@ -101,7 +101,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.projects.list() + client.accounting.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -269,7 +271,9 @@ async def list( async def main() -> None: - await client.accounting.projects.list() + await client.accounting.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/purchase_orders/client.py b/src/merge/resources/accounting/resources/purchase_orders/client.py index 4b7a1931..5b6a4ab6 100644 --- a/src/merge/resources/accounting/resources/purchase_orders/client.py +++ b/src/merge/resources/accounting/resources/purchase_orders/client.py @@ -128,7 +128,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.purchase_orders.list() + client.accounting.purchase_orders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -322,7 +324,9 @@ def line_items_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.purchase_orders.line_items_remote_field_classes_list() + client.accounting.purchase_orders.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.line_items_remote_field_classes_list( cursor=cursor, @@ -417,7 +421,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.purchase_orders.remote_field_classes_list() + client.accounting.purchase_orders.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -546,7 +552,9 @@ async def list( async def main() -> None: - await client.accounting.purchase_orders.list() + await client.accounting.purchase_orders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -764,7 +772,9 @@ async def line_items_remote_field_classes_list( async def main() -> None: - await client.accounting.purchase_orders.line_items_remote_field_classes_list() + await client.accounting.purchase_orders.line_items_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -875,7 +885,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.accounting.purchase_orders.remote_field_classes_list() + await client.accounting.purchase_orders.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/sync_status/client.py b/src/merge/resources/accounting/resources/sync_status/client.py index b1158fdd..3c1b31e8 100644 --- a/src/merge/resources/accounting/resources/sync_status/client.py +++ b/src/merge/resources/accounting/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.sync_status.list() + client.accounting.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.accounting.sync_status.list() + await client.accounting.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/tax_rates/client.py b/src/merge/resources/accounting/resources/tax_rates/client.py index fa872829..29f1ca42 100644 --- a/src/merge/resources/accounting/resources/tax_rates/client.py +++ b/src/merge/resources/accounting/resources/tax_rates/client.py @@ -103,7 +103,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.tax_rates.list() + client.accounting.tax_rates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -276,7 +278,9 @@ async def list( async def main() -> None: - await client.accounting.tax_rates.list() + await client.accounting.tax_rates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/tracking_categories/client.py b/src/merge/resources/accounting/resources/tracking_categories/client.py index 61b7c215..bdd73f97 100644 --- a/src/merge/resources/accounting/resources/tracking_categories/client.py +++ b/src/merge/resources/accounting/resources/tracking_categories/client.py @@ -119,7 +119,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.tracking_categories.list() + client.accounting.tracking_categories.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category_type=category_type, @@ -322,7 +324,9 @@ async def list( async def main() -> None: - await client.accounting.tracking_categories.list() + await client.accounting.tracking_categories.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/transactions/client.py b/src/merge/resources/accounting/resources/transactions/client.py index 68b26ccd..0dd5c1d1 100644 --- a/src/merge/resources/accounting/resources/transactions/client.py +++ b/src/merge/resources/accounting/resources/transactions/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.transactions.list() + client.accounting.transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -287,7 +289,9 @@ async def list( async def main() -> None: - await client.accounting.transactions.list() + await client.accounting.transactions.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/resources/vendor_credits/client.py b/src/merge/resources/accounting/resources/vendor_credits/client.py index 077ae72f..35f220c2 100644 --- a/src/merge/resources/accounting/resources/vendor_credits/client.py +++ b/src/merge/resources/accounting/resources/vendor_credits/client.py @@ -115,7 +115,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.accounting.vendor_credits.list() + client.accounting.vendor_credits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -367,7 +369,9 @@ async def list( async def main() -> None: - await client.accounting.vendor_credits.list() + await client.accounting.vendor_credits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/accounting/types/__init__.py b/src/merge/resources/accounting/types/__init__.py index ccc53eea..46cc92d3 100644 --- a/src/merge/resources/accounting/types/__init__.py +++ b/src/merge/resources/accounting/types/__init__.py @@ -18,7 +18,6 @@ from .account_request import AccountRequest from .account_request_account_type import AccountRequestAccountType from .account_request_classification import AccountRequestClassification -from .account_request_currency import AccountRequestCurrency from .account_request_status import AccountRequestStatus from .account_response import AccountResponse from .account_status import AccountStatus @@ -70,7 +69,6 @@ from .bank_feed_transaction_response import BankFeedTransactionResponse from .cash_flow_statement import CashFlowStatement from .cash_flow_statement_company import CashFlowStatementCompany -from .cash_flow_statement_currency import CashFlowStatementCurrency from .categories_enum import CategoriesEnum from .category_enum import CategoryEnum from .category_type_enum import CategoryTypeEnum @@ -163,7 +161,9 @@ from .expense_line_tracking_categories_item import ExpenseLineTrackingCategoriesItem from .expense_line_tracking_category import ExpenseLineTrackingCategory from .expense_report import ExpenseReport +from .expense_report_accounting_period import ExpenseReportAccountingPeriod from .expense_report_company import ExpenseReportCompany +from .expense_report_employee import ExpenseReportEmployee from .expense_report_line import ExpenseReportLine from .expense_report_line_account import ExpenseReportLineAccount from .expense_report_line_company import ExpenseReportLineCompany @@ -182,6 +182,7 @@ from .expense_report_request_accounting_period import ExpenseReportRequestAccountingPeriod from .expense_report_request_company import ExpenseReportRequestCompany from .expense_report_request_employee import ExpenseReportRequestEmployee +from .expense_report_request_status import ExpenseReportRequestStatus from .expense_report_response import ExpenseReportResponse from .expense_report_status import ExpenseReportStatus from .expense_report_status_enum import ExpenseReportStatusEnum @@ -382,7 +383,6 @@ from .patched_payment_request_account import PatchedPaymentRequestAccount from .patched_payment_request_accounting_period import PatchedPaymentRequestAccountingPeriod from .patched_payment_request_applied_to_lines_item import PatchedPaymentRequestAppliedToLinesItem -from .patched_payment_request_company import PatchedPaymentRequestCompany from .patched_payment_request_contact import PatchedPaymentRequestContact from .patched_payment_request_currency import PatchedPaymentRequestCurrency from .patched_payment_request_payment_method import PatchedPaymentRequestPaymentMethod @@ -434,7 +434,6 @@ from .purchase_order_payment_term import PurchaseOrderPaymentTerm from .purchase_order_request import PurchaseOrderRequest from .purchase_order_request_company import PurchaseOrderRequestCompany -from .purchase_order_request_currency import PurchaseOrderRequestCurrency from .purchase_order_request_delivery_address import PurchaseOrderRequestDeliveryAddress from .purchase_order_request_payment_term import PurchaseOrderRequestPaymentTerm from .purchase_order_request_status import PurchaseOrderRequestStatus @@ -466,6 +465,7 @@ from .status_895_enum import Status895Enum from .status_fd_5_enum import StatusFd5Enum from .sync_status import SyncStatus +from .sync_status_last_sync_result import SyncStatusLastSyncResult from .sync_status_status import SyncStatusStatus from .tax_component import TaxComponent from .tax_component_component_type import TaxComponentComponentType @@ -480,6 +480,7 @@ from .transaction import Transaction from .transaction_account import TransactionAccount from .transaction_accounting_period import TransactionAccountingPeriod +from .transaction_company import TransactionCompany from .transaction_contact import TransactionContact from .transaction_currency import TransactionCurrency from .transaction_currency_enum import TransactionCurrencyEnum @@ -510,6 +511,7 @@ from .vendor_credit_line_request_account import VendorCreditLineRequestAccount from .vendor_credit_line_request_contact import VendorCreditLineRequestContact from .vendor_credit_line_request_project import VendorCreditLineRequestProject +from .vendor_credit_lines_item import VendorCreditLinesItem from .vendor_credit_request import VendorCreditRequest from .vendor_credit_request_accounting_period import VendorCreditRequestAccountingPeriod from .vendor_credit_request_company import VendorCreditRequestCompany @@ -539,7 +541,6 @@ "AccountRequest", "AccountRequestAccountType", "AccountRequestClassification", - "AccountRequestCurrency", "AccountRequestStatus", "AccountResponse", "AccountStatus", @@ -591,7 +592,6 @@ "BankFeedTransactionResponse", "CashFlowStatement", "CashFlowStatementCompany", - "CashFlowStatementCurrency", "CategoriesEnum", "CategoryEnum", "CategoryTypeEnum", @@ -684,7 +684,9 @@ "ExpenseLineTrackingCategoriesItem", "ExpenseLineTrackingCategory", "ExpenseReport", + "ExpenseReportAccountingPeriod", "ExpenseReportCompany", + "ExpenseReportEmployee", "ExpenseReportLine", "ExpenseReportLineAccount", "ExpenseReportLineCompany", @@ -703,6 +705,7 @@ "ExpenseReportRequestAccountingPeriod", "ExpenseReportRequestCompany", "ExpenseReportRequestEmployee", + "ExpenseReportRequestStatus", "ExpenseReportResponse", "ExpenseReportStatus", "ExpenseReportStatusEnum", @@ -899,7 +902,6 @@ "PatchedPaymentRequestAccount", "PatchedPaymentRequestAccountingPeriod", "PatchedPaymentRequestAppliedToLinesItem", - "PatchedPaymentRequestCompany", "PatchedPaymentRequestContact", "PatchedPaymentRequestCurrency", "PatchedPaymentRequestPaymentMethod", @@ -951,7 +953,6 @@ "PurchaseOrderPaymentTerm", "PurchaseOrderRequest", "PurchaseOrderRequestCompany", - "PurchaseOrderRequestCurrency", "PurchaseOrderRequestDeliveryAddress", "PurchaseOrderRequestPaymentTerm", "PurchaseOrderRequestStatus", @@ -983,6 +984,7 @@ "Status895Enum", "StatusFd5Enum", "SyncStatus", + "SyncStatusLastSyncResult", "SyncStatusStatus", "TaxComponent", "TaxComponentComponentType", @@ -997,6 +999,7 @@ "Transaction", "TransactionAccount", "TransactionAccountingPeriod", + "TransactionCompany", "TransactionContact", "TransactionCurrency", "TransactionCurrencyEnum", @@ -1025,6 +1028,7 @@ "VendorCreditLineRequestAccount", "VendorCreditLineRequestContact", "VendorCreditLineRequestProject", + "VendorCreditLinesItem", "VendorCreditRequest", "VendorCreditRequestAccountingPeriod", "VendorCreditRequestCompany", diff --git a/src/merge/resources/accounting/types/account_request.py b/src/merge/resources/accounting/types/account_request.py index 471e444e..3aeb7c05 100644 --- a/src/merge/resources/accounting/types/account_request.py +++ b/src/merge/resources/accounting/types/account_request.py @@ -7,7 +7,6 @@ from ....core.unchecked_base_model import UncheckedBaseModel from .account_request_account_type import AccountRequestAccountType from .account_request_classification import AccountRequestClassification -from .account_request_currency import AccountRequestCurrency from .account_request_status import AccountRequestStatus @@ -87,318 +86,7 @@ class AccountRequest(UncheckedBaseModel): The account's current balance. """ - currency: typing.Optional[AccountRequestCurrency] = pydantic.Field(default=None) - """ - The account's currency. - - * `XUA` - ADB Unit of Account - * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) - * `ALL` - Albanian Lek - * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar - * `ADP` - Andorran Peseta - * `AOA` - Angolan Kwanza - * `AOK` - Angolan Kwanza (1977–1991) - * `AON` - Angolan New Kwanza (1990–2000) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `ARA` - Argentine Austral - * `ARS` - Argentine Peso - * `ARM` - Argentine Peso (1881–1970) - * `ARP` - Argentine Peso (1983–1985) - * `ARL` - Argentine Peso Ley (1970–1983) - * `AMD` - Armenian Dram - * `AWG` - Aruban Florin - * `AUD` - Australian Dollar - * `ATS` - Austrian Schilling - * `AZN` - Azerbaijani Manat - * `AZM` - Azerbaijani Manat (1993–2006) - * `BSD` - Bahamian Dollar - * `BHD` - Bahraini Dinar - * `BDT` - Bangladeshi Taka - * `BBD` - Barbadian Dollar - * `BYN` - Belarusian Ruble - * `BYB` - Belarusian Ruble (1994–1999) - * `BYR` - Belarusian Ruble (2000–2016) - * `BEF` - Belgian Franc - * `BEC` - Belgian Franc (convertible) - * `BEL` - Belgian Franc (financial) - * `BZD` - Belize Dollar - * `BMD` - Bermudan Dollar - * `BTN` - Bhutanese Ngultrum - * `BOB` - Bolivian Boliviano - * `BOL` - Bolivian Boliviano (1863–1963) - * `BOV` - Bolivian Mvdol - * `BOP` - Bolivian Peso - * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BWP` - Botswanan Pula - * `BRC` - Brazilian Cruzado (1986–1989) - * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BRN` - Brazilian New Cruzado (1989–1990) - * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BRL` - Brazilian Real - * `GBP` - British Pound - * `BND` - Brunei Dollar - * `BGL` - Bulgarian Hard Lev - * `BGN` - Bulgarian Lev - * `BGO` - Bulgarian Lev (1879–1952) - * `BGM` - Bulgarian Socialist Lev - * `BUK` - Burmese Kyat - * `BIF` - Burundian Franc - * `XPF` - CFP Franc - * `KHR` - Cambodian Riel - * `CAD` - Canadian Dollar - * `CVE` - Cape Verdean Escudo - * `KYD` - Cayman Islands Dollar - * `XAF` - Central African CFA Franc - * `CLE` - Chilean Escudo - * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) - * `CNX` - Chinese People’s Bank Dollar - * `CNY` - Chinese Yuan - * `CNH` - Chinese Yuan (offshore) - * `COP` - Colombian Peso - * `COU` - Colombian Real Value Unit - * `KMF` - Comorian Franc - * `CDF` - Congolese Franc - * `CRC` - Costa Rican Colón - * `HRD` - Croatian Dinar - * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso - * `CUP` - Cuban Peso - * `CYP` - Cypriot Pound - * `CZK` - Czech Koruna - * `CSK` - Czechoslovak Hard Koruna - * `DKK` - Danish Krone - * `DJF` - Djiboutian Franc - * `DOP` - Dominican Peso - * `NLG` - Dutch Guilder - * `XCD` - East Caribbean Dollar - * `DDM` - East German Mark - * `ECS` - Ecuadorian Sucre - * `ECV` - Ecuadorian Unit of Constant Value - * `EGP` - Egyptian Pound - * `GQE` - Equatorial Guinean Ekwele - * `ERN` - Eritrean Nakfa - * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr - * `EUR` - Euro - * `XBA` - European Composite Unit - * `XEU` - European Currency Unit - * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) - * `XBD` - European Unit of Account (XBD) - * `FKP` - Falkland Islands Pound - * `FJD` - Fijian Dollar - * `FIM` - Finnish Markka - * `FRF` - French Franc - * `XFO` - French Gold Franc - * `XFU` - French UIC-Franc - * `GMD` - Gambian Dalasi - * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari - * `DEM` - German Mark - * `GHS` - Ghanaian Cedi - * `GHC` - Ghanaian Cedi (1979–2007) - * `GIP` - Gibraltar Pound - * `XAU` - Gold - * `GRD` - Greek Drachma - * `GTQ` - Guatemalan Quetzal - * `GWP` - Guinea-Bissau Peso - * `GNF` - Guinean Franc - * `GNS` - Guinean Syli - * `GYD` - Guyanaese Dollar - * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira - * `HKD` - Hong Kong Dollar - * `HUF` - Hungarian Forint - * `IMP` - IMP - * `ISK` - Icelandic Króna - * `ISJ` - Icelandic Króna (1918–1981) - * `INR` - Indian Rupee - * `IDR` - Indonesian Rupiah - * `IRR` - Iranian Rial - * `IQD` - Iraqi Dinar - * `IEP` - Irish Pound - * `ILS` - Israeli New Shekel - * `ILP` - Israeli Pound - * `ILR` - Israeli Shekel (1980–1985) - * `ITL` - Italian Lira - * `JMD` - Jamaican Dollar - * `JPY` - Japanese Yen - * `JOD` - Jordanian Dinar - * `KZT` - Kazakhstani Tenge - * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar - * `KGS` - Kyrgystani Som - * `LAK` - Laotian Kip - * `LVL` - Latvian Lats - * `LVR` - Latvian Ruble - * `LBP` - Lebanese Pound - * `LSL` - Lesotho Loti - * `LRD` - Liberian Dollar - * `LYD` - Libyan Dinar - * `LTL` - Lithuanian Litas - * `LTT` - Lithuanian Talonas - * `LUL` - Luxembourg Financial Franc - * `LUC` - Luxembourgian Convertible Franc - * `LUF` - Luxembourgian Franc - * `MOP` - Macanese Pataca - * `MKD` - Macedonian Denar - * `MKN` - Macedonian Denar (1992–1993) - * `MGA` - Malagasy Ariary - * `MGF` - Malagasy Franc - * `MWK` - Malawian Kwacha - * `MYR` - Malaysian Ringgit - * `MVR` - Maldivian Rufiyaa - * `MVP` - Maldivian Rupee (1947–1981) - * `MLF` - Malian Franc - * `MTL` - Maltese Lira - * `MTP` - Maltese Pound - * `MRU` - Mauritanian Ouguiya - * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MUR` - Mauritian Rupee - * `MXV` - Mexican Investment Unit - * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) - * `MDC` - Moldovan Cupon - * `MDL` - Moldovan Leu - * `MCF` - Monegasque Franc - * `MNT` - Mongolian Tugrik - * `MAD` - Moroccan Dirham - * `MAF` - Moroccan Franc - * `MZE` - Mozambican Escudo - * `MZN` - Mozambican Metical - * `MZM` - Mozambican Metical (1980–2006) - * `MMK` - Myanmar Kyat - * `NAD` - Namibian Dollar - * `NPR` - Nepalese Rupee - * `ANG` - Netherlands Antillean Guilder - * `TWD` - New Taiwan Dollar - * `NZD` - New Zealand Dollar - * `NIO` - Nicaraguan Córdoba - * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NGN` - Nigerian Naira - * `KPW` - North Korean Won - * `NOK` - Norwegian Krone - * `OMR` - Omani Rial - * `PKR` - Pakistani Rupee - * `XPD` - Palladium - * `PAB` - Panamanian Balboa - * `PGK` - Papua New Guinean Kina - * `PYG` - Paraguayan Guarani - * `PEI` - Peruvian Inti - * `PEN` - Peruvian Sol - * `PES` - Peruvian Sol (1863–1965) - * `PHP` - Philippine Peso - * `XPT` - Platinum - * `PLN` - Polish Zloty - * `PLZ` - Polish Zloty (1950–1995) - * `PTE` - Portuguese Escudo - * `GWE` - Portuguese Guinea Escudo - * `QAR` - Qatari Rial - * `XRE` - RINET Funds - * `RHD` - Rhodesian Dollar - * `RON` - Romanian Leu - * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble - * `RUR` - Russian Ruble (1991–1998) - * `RWF` - Rwandan Franc - * `SVC` - Salvadoran Colón - * `WST` - Samoan Tala - * `SAR` - Saudi Riyal - * `RSD` - Serbian Dinar - * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee - * `SLL` - Sierra Leonean Leone - * `XAG` - Silver - * `SGD` - Singapore Dollar - * `SKK` - Slovak Koruna - * `SIT` - Slovenian Tolar - * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling - * `ZAR` - South African Rand - * `ZAL` - South African Rand (financial) - * `KRH` - South Korean Hwan (1953–1962) - * `KRW` - South Korean Won - * `KRO` - South Korean Won (1945–1953) - * `SSP` - South Sudanese Pound - * `SUR` - Soviet Rouble - * `ESP` - Spanish Peseta - * `ESA` - Spanish Peseta (A account) - * `ESB` - Spanish Peseta (convertible account) - * `XDR` - Special Drawing Rights - * `LKR` - Sri Lankan Rupee - * `SHP` - St. Helena Pound - * `XSU` - Sucre - * `SDD` - Sudanese Dinar (1992–2007) - * `SDG` - Sudanese Pound - * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar - * `SRG` - Surinamese Guilder - * `SZL` - Swazi Lilangeni - * `SEK` - Swedish Krona - * `CHF` - Swiss Franc - * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `TVD` - TVD - * `TJR` - Tajikistani Ruble - * `TJS` - Tajikistani Somoni - * `TZS` - Tanzanian Shilling - * `XTS` - Testing Currency Code - * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is involved - * `TPE` - Timorese Escudo - * `TOP` - Tongan Paʻanga - * `TTD` - Trinidad & Tobago Dollar - * `TND` - Tunisian Dinar - * `TRY` - Turkish Lira - * `TRL` - Turkish Lira (1922–2005) - * `TMT` - Turkmenistani Manat - * `TMM` - Turkmenistani Manat (1993–2009) - * `USD` - US Dollar - * `USN` - US Dollar (Next day) - * `USS` - US Dollar (Same day) - * `UGX` - Ugandan Shilling - * `UGS` - Ugandan Shilling (1966–1987) - * `UAH` - Ukrainian Hryvnia - * `UAK` - Ukrainian Karbovanets - * `AED` - United Arab Emirates Dirham - * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYU` - Uruguayan Peso - * `UYP` - Uruguayan Peso (1975–1993) - * `UYI` - Uruguayan Peso (Indexed Units) - * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu - * `VES` - Venezuelan Bolívar - * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEF` - Venezuelan Bolívar (2008–2018) - * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro - * `CHW` - WIR Franc - * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN - * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRZ` - Zairean Zaire (1971–1993) - * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWR` - Zimbabwean Dollar (2008) - * `ZWL` - Zimbabwean Dollar (2009) - """ - + currency: typing.Optional[typing.Optional[typing.Any]] = None account_number: typing.Optional[str] = pydantic.Field(default=None) """ The account's number. diff --git a/src/merge/resources/accounting/types/account_request_currency.py b/src/merge/resources/accounting/types/account_request_currency.py deleted file mode 100644 index e5e42728..00000000 --- a/src/merge/resources/accounting/types/account_request_currency.py +++ /dev/null @@ -1,7 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -from .transaction_currency_enum import TransactionCurrencyEnum - -AccountRequestCurrency = typing.Union[TransactionCurrencyEnum, str] diff --git a/src/merge/resources/accounting/types/cash_flow_statement.py b/src/merge/resources/accounting/types/cash_flow_statement.py index ef460a0e..1731ca7d 100644 --- a/src/merge/resources/accounting/types/cash_flow_statement.py +++ b/src/merge/resources/accounting/types/cash_flow_statement.py @@ -7,7 +7,6 @@ from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel from .cash_flow_statement_company import CashFlowStatementCompany -from .cash_flow_statement_currency import CashFlowStatementCurrency from .remote_data import RemoteData from .report_item import ReportItem @@ -43,318 +42,7 @@ class CashFlowStatement(UncheckedBaseModel): The cash flow statement's name. """ - currency: typing.Optional[CashFlowStatementCurrency] = pydantic.Field(default=None) - """ - The cash flow statement's currency. - - * `XUA` - ADB Unit of Account - * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) - * `ALL` - Albanian Lek - * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar - * `ADP` - Andorran Peseta - * `AOA` - Angolan Kwanza - * `AOK` - Angolan Kwanza (1977–1991) - * `AON` - Angolan New Kwanza (1990–2000) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `ARA` - Argentine Austral - * `ARS` - Argentine Peso - * `ARM` - Argentine Peso (1881–1970) - * `ARP` - Argentine Peso (1983–1985) - * `ARL` - Argentine Peso Ley (1970–1983) - * `AMD` - Armenian Dram - * `AWG` - Aruban Florin - * `AUD` - Australian Dollar - * `ATS` - Austrian Schilling - * `AZN` - Azerbaijani Manat - * `AZM` - Azerbaijani Manat (1993–2006) - * `BSD` - Bahamian Dollar - * `BHD` - Bahraini Dinar - * `BDT` - Bangladeshi Taka - * `BBD` - Barbadian Dollar - * `BYN` - Belarusian Ruble - * `BYB` - Belarusian Ruble (1994–1999) - * `BYR` - Belarusian Ruble (2000–2016) - * `BEF` - Belgian Franc - * `BEC` - Belgian Franc (convertible) - * `BEL` - Belgian Franc (financial) - * `BZD` - Belize Dollar - * `BMD` - Bermudan Dollar - * `BTN` - Bhutanese Ngultrum - * `BOB` - Bolivian Boliviano - * `BOL` - Bolivian Boliviano (1863–1963) - * `BOV` - Bolivian Mvdol - * `BOP` - Bolivian Peso - * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BWP` - Botswanan Pula - * `BRC` - Brazilian Cruzado (1986–1989) - * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BRN` - Brazilian New Cruzado (1989–1990) - * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BRL` - Brazilian Real - * `GBP` - British Pound - * `BND` - Brunei Dollar - * `BGL` - Bulgarian Hard Lev - * `BGN` - Bulgarian Lev - * `BGO` - Bulgarian Lev (1879–1952) - * `BGM` - Bulgarian Socialist Lev - * `BUK` - Burmese Kyat - * `BIF` - Burundian Franc - * `XPF` - CFP Franc - * `KHR` - Cambodian Riel - * `CAD` - Canadian Dollar - * `CVE` - Cape Verdean Escudo - * `KYD` - Cayman Islands Dollar - * `XAF` - Central African CFA Franc - * `CLE` - Chilean Escudo - * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) - * `CNX` - Chinese People’s Bank Dollar - * `CNY` - Chinese Yuan - * `CNH` - Chinese Yuan (offshore) - * `COP` - Colombian Peso - * `COU` - Colombian Real Value Unit - * `KMF` - Comorian Franc - * `CDF` - Congolese Franc - * `CRC` - Costa Rican Colón - * `HRD` - Croatian Dinar - * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso - * `CUP` - Cuban Peso - * `CYP` - Cypriot Pound - * `CZK` - Czech Koruna - * `CSK` - Czechoslovak Hard Koruna - * `DKK` - Danish Krone - * `DJF` - Djiboutian Franc - * `DOP` - Dominican Peso - * `NLG` - Dutch Guilder - * `XCD` - East Caribbean Dollar - * `DDM` - East German Mark - * `ECS` - Ecuadorian Sucre - * `ECV` - Ecuadorian Unit of Constant Value - * `EGP` - Egyptian Pound - * `GQE` - Equatorial Guinean Ekwele - * `ERN` - Eritrean Nakfa - * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr - * `EUR` - Euro - * `XBA` - European Composite Unit - * `XEU` - European Currency Unit - * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) - * `XBD` - European Unit of Account (XBD) - * `FKP` - Falkland Islands Pound - * `FJD` - Fijian Dollar - * `FIM` - Finnish Markka - * `FRF` - French Franc - * `XFO` - French Gold Franc - * `XFU` - French UIC-Franc - * `GMD` - Gambian Dalasi - * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari - * `DEM` - German Mark - * `GHS` - Ghanaian Cedi - * `GHC` - Ghanaian Cedi (1979–2007) - * `GIP` - Gibraltar Pound - * `XAU` - Gold - * `GRD` - Greek Drachma - * `GTQ` - Guatemalan Quetzal - * `GWP` - Guinea-Bissau Peso - * `GNF` - Guinean Franc - * `GNS` - Guinean Syli - * `GYD` - Guyanaese Dollar - * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira - * `HKD` - Hong Kong Dollar - * `HUF` - Hungarian Forint - * `IMP` - IMP - * `ISK` - Icelandic Króna - * `ISJ` - Icelandic Króna (1918–1981) - * `INR` - Indian Rupee - * `IDR` - Indonesian Rupiah - * `IRR` - Iranian Rial - * `IQD` - Iraqi Dinar - * `IEP` - Irish Pound - * `ILS` - Israeli New Shekel - * `ILP` - Israeli Pound - * `ILR` - Israeli Shekel (1980–1985) - * `ITL` - Italian Lira - * `JMD` - Jamaican Dollar - * `JPY` - Japanese Yen - * `JOD` - Jordanian Dinar - * `KZT` - Kazakhstani Tenge - * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar - * `KGS` - Kyrgystani Som - * `LAK` - Laotian Kip - * `LVL` - Latvian Lats - * `LVR` - Latvian Ruble - * `LBP` - Lebanese Pound - * `LSL` - Lesotho Loti - * `LRD` - Liberian Dollar - * `LYD` - Libyan Dinar - * `LTL` - Lithuanian Litas - * `LTT` - Lithuanian Talonas - * `LUL` - Luxembourg Financial Franc - * `LUC` - Luxembourgian Convertible Franc - * `LUF` - Luxembourgian Franc - * `MOP` - Macanese Pataca - * `MKD` - Macedonian Denar - * `MKN` - Macedonian Denar (1992–1993) - * `MGA` - Malagasy Ariary - * `MGF` - Malagasy Franc - * `MWK` - Malawian Kwacha - * `MYR` - Malaysian Ringgit - * `MVR` - Maldivian Rufiyaa - * `MVP` - Maldivian Rupee (1947–1981) - * `MLF` - Malian Franc - * `MTL` - Maltese Lira - * `MTP` - Maltese Pound - * `MRU` - Mauritanian Ouguiya - * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MUR` - Mauritian Rupee - * `MXV` - Mexican Investment Unit - * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) - * `MDC` - Moldovan Cupon - * `MDL` - Moldovan Leu - * `MCF` - Monegasque Franc - * `MNT` - Mongolian Tugrik - * `MAD` - Moroccan Dirham - * `MAF` - Moroccan Franc - * `MZE` - Mozambican Escudo - * `MZN` - Mozambican Metical - * `MZM` - Mozambican Metical (1980–2006) - * `MMK` - Myanmar Kyat - * `NAD` - Namibian Dollar - * `NPR` - Nepalese Rupee - * `ANG` - Netherlands Antillean Guilder - * `TWD` - New Taiwan Dollar - * `NZD` - New Zealand Dollar - * `NIO` - Nicaraguan Córdoba - * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NGN` - Nigerian Naira - * `KPW` - North Korean Won - * `NOK` - Norwegian Krone - * `OMR` - Omani Rial - * `PKR` - Pakistani Rupee - * `XPD` - Palladium - * `PAB` - Panamanian Balboa - * `PGK` - Papua New Guinean Kina - * `PYG` - Paraguayan Guarani - * `PEI` - Peruvian Inti - * `PEN` - Peruvian Sol - * `PES` - Peruvian Sol (1863–1965) - * `PHP` - Philippine Peso - * `XPT` - Platinum - * `PLN` - Polish Zloty - * `PLZ` - Polish Zloty (1950–1995) - * `PTE` - Portuguese Escudo - * `GWE` - Portuguese Guinea Escudo - * `QAR` - Qatari Rial - * `XRE` - RINET Funds - * `RHD` - Rhodesian Dollar - * `RON` - Romanian Leu - * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble - * `RUR` - Russian Ruble (1991–1998) - * `RWF` - Rwandan Franc - * `SVC` - Salvadoran Colón - * `WST` - Samoan Tala - * `SAR` - Saudi Riyal - * `RSD` - Serbian Dinar - * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee - * `SLL` - Sierra Leonean Leone - * `XAG` - Silver - * `SGD` - Singapore Dollar - * `SKK` - Slovak Koruna - * `SIT` - Slovenian Tolar - * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling - * `ZAR` - South African Rand - * `ZAL` - South African Rand (financial) - * `KRH` - South Korean Hwan (1953–1962) - * `KRW` - South Korean Won - * `KRO` - South Korean Won (1945–1953) - * `SSP` - South Sudanese Pound - * `SUR` - Soviet Rouble - * `ESP` - Spanish Peseta - * `ESA` - Spanish Peseta (A account) - * `ESB` - Spanish Peseta (convertible account) - * `XDR` - Special Drawing Rights - * `LKR` - Sri Lankan Rupee - * `SHP` - St. Helena Pound - * `XSU` - Sucre - * `SDD` - Sudanese Dinar (1992–2007) - * `SDG` - Sudanese Pound - * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar - * `SRG` - Surinamese Guilder - * `SZL` - Swazi Lilangeni - * `SEK` - Swedish Krona - * `CHF` - Swiss Franc - * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `TVD` - TVD - * `TJR` - Tajikistani Ruble - * `TJS` - Tajikistani Somoni - * `TZS` - Tanzanian Shilling - * `XTS` - Testing Currency Code - * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is involved - * `TPE` - Timorese Escudo - * `TOP` - Tongan Paʻanga - * `TTD` - Trinidad & Tobago Dollar - * `TND` - Tunisian Dinar - * `TRY` - Turkish Lira - * `TRL` - Turkish Lira (1922–2005) - * `TMT` - Turkmenistani Manat - * `TMM` - Turkmenistani Manat (1993–2009) - * `USD` - US Dollar - * `USN` - US Dollar (Next day) - * `USS` - US Dollar (Same day) - * `UGX` - Ugandan Shilling - * `UGS` - Ugandan Shilling (1966–1987) - * `UAH` - Ukrainian Hryvnia - * `UAK` - Ukrainian Karbovanets - * `AED` - United Arab Emirates Dirham - * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYU` - Uruguayan Peso - * `UYP` - Uruguayan Peso (1975–1993) - * `UYI` - Uruguayan Peso (Indexed Units) - * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu - * `VES` - Venezuelan Bolívar - * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEF` - Venezuelan Bolívar (2008–2018) - * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro - * `CHW` - WIR Franc - * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN - * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRZ` - Zairean Zaire (1971–1993) - * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWR` - Zimbabwean Dollar (2008) - * `ZWL` - Zimbabwean Dollar (2009) - """ - + currency: typing.Optional[typing.Optional[typing.Any]] = None company: typing.Optional[CashFlowStatementCompany] = pydantic.Field(default=None) """ The company the cash flow statement belongs to. diff --git a/src/merge/resources/accounting/types/cash_flow_statement_currency.py b/src/merge/resources/accounting/types/cash_flow_statement_currency.py deleted file mode 100644 index 09c651f9..00000000 --- a/src/merge/resources/accounting/types/cash_flow_statement_currency.py +++ /dev/null @@ -1,7 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -from .transaction_currency_enum import TransactionCurrencyEnum - -CashFlowStatementCurrency = typing.Union[TransactionCurrencyEnum, str] diff --git a/src/merge/resources/accounting/types/credit_note_line_item_request_project.py b/src/merge/resources/accounting/types/credit_note_line_item_request_project.py index 334b238e..d9727951 100644 --- a/src/merge/resources/accounting/types/credit_note_line_item_request_project.py +++ b/src/merge/resources/accounting/types/credit_note_line_item_request_project.py @@ -2,6 +2,6 @@ import typing -from .contact import Contact +from .project import Project -CreditNoteLineItemRequestProject = typing.Union[str, Contact] +CreditNoteLineItemRequestProject = typing.Union[str, Project] diff --git a/src/merge/resources/accounting/types/expense_line_request_project.py b/src/merge/resources/accounting/types/expense_line_request_project.py index a4a23629..3b00a37e 100644 --- a/src/merge/resources/accounting/types/expense_line_request_project.py +++ b/src/merge/resources/accounting/types/expense_line_request_project.py @@ -2,6 +2,6 @@ import typing -from .contact import Contact +from .project import Project -ExpenseLineRequestProject = typing.Union[str, Contact] +ExpenseLineRequestProject = typing.Union[str, Project] diff --git a/src/merge/resources/accounting/types/expense_report.py b/src/merge/resources/accounting/types/expense_report.py index 9cd03e8d..75e36829 100644 --- a/src/merge/resources/accounting/types/expense_report.py +++ b/src/merge/resources/accounting/types/expense_report.py @@ -6,7 +6,9 @@ import pydantic from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel +from .expense_report_accounting_period import ExpenseReportAccountingPeriod from .expense_report_company import ExpenseReportCompany +from .expense_report_employee import ExpenseReportEmployee from .expense_report_line import ExpenseReportLine from .expense_report_status import ExpenseReportStatus from .remote_data import RemoteData @@ -51,7 +53,7 @@ class ExpenseReport(UncheckedBaseModel): Human-readable expense report identifier. """ - employee: typing.Optional[str] = pydantic.Field(default=None) + employee: typing.Optional[ExpenseReportEmployee] = pydantic.Field(default=None) """ Identifier for the employee who submitted or is associated with the expense report """ @@ -389,7 +391,7 @@ class ExpenseReport(UncheckedBaseModel): A brief description or purpose for the expense report """ - accounting_period: typing.Optional[str] = pydantic.Field(default=None) + accounting_period: typing.Optional[ExpenseReportAccountingPeriod] = pydantic.Field(default=None) """ The accounting period the report was posted in """ diff --git a/src/merge/resources/accounting/types/expense_report_accounting_period.py b/src/merge/resources/accounting/types/expense_report_accounting_period.py new file mode 100644 index 00000000..d72ba214 --- /dev/null +++ b/src/merge/resources/accounting/types/expense_report_accounting_period.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .accounting_period import AccountingPeriod + +ExpenseReportAccountingPeriod = typing.Union[str, AccountingPeriod] diff --git a/src/merge/resources/accounting/types/expense_report_employee.py b/src/merge/resources/accounting/types/expense_report_employee.py new file mode 100644 index 00000000..5ef3f28c --- /dev/null +++ b/src/merge/resources/accounting/types/expense_report_employee.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .employee import Employee + +ExpenseReportEmployee = typing.Union[str, Employee] diff --git a/src/merge/resources/accounting/types/expense_report_line.py b/src/merge/resources/accounting/types/expense_report_line.py index a5b01dfc..6f068b25 100644 --- a/src/merge/resources/accounting/types/expense_report_line.py +++ b/src/merge/resources/accounting/types/expense_report_line.py @@ -13,7 +13,6 @@ from .expense_report_line_project import ExpenseReportLineProject from .expense_report_line_tax_rate import ExpenseReportLineTaxRate from .remote_field import RemoteField -from .transaction_currency_enum import TransactionCurrencyEnum class ExpenseReportLine(UncheckedBaseModel): @@ -59,318 +58,7 @@ class ExpenseReportLine(UncheckedBaseModel): The amount of the expense for the line item. """ - currency: typing.Optional[TransactionCurrencyEnum] = pydantic.Field(default=None) - """ - Currency of the expense line (if different from the report currency). - - * `XUA` - ADB Unit of Account - * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) - * `ALL` - Albanian Lek - * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar - * `ADP` - Andorran Peseta - * `AOA` - Angolan Kwanza - * `AOK` - Angolan Kwanza (1977–1991) - * `AON` - Angolan New Kwanza (1990–2000) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `ARA` - Argentine Austral - * `ARS` - Argentine Peso - * `ARM` - Argentine Peso (1881–1970) - * `ARP` - Argentine Peso (1983–1985) - * `ARL` - Argentine Peso Ley (1970–1983) - * `AMD` - Armenian Dram - * `AWG` - Aruban Florin - * `AUD` - Australian Dollar - * `ATS` - Austrian Schilling - * `AZN` - Azerbaijani Manat - * `AZM` - Azerbaijani Manat (1993–2006) - * `BSD` - Bahamian Dollar - * `BHD` - Bahraini Dinar - * `BDT` - Bangladeshi Taka - * `BBD` - Barbadian Dollar - * `BYN` - Belarusian Ruble - * `BYB` - Belarusian Ruble (1994–1999) - * `BYR` - Belarusian Ruble (2000–2016) - * `BEF` - Belgian Franc - * `BEC` - Belgian Franc (convertible) - * `BEL` - Belgian Franc (financial) - * `BZD` - Belize Dollar - * `BMD` - Bermudan Dollar - * `BTN` - Bhutanese Ngultrum - * `BOB` - Bolivian Boliviano - * `BOL` - Bolivian Boliviano (1863–1963) - * `BOV` - Bolivian Mvdol - * `BOP` - Bolivian Peso - * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BWP` - Botswanan Pula - * `BRC` - Brazilian Cruzado (1986–1989) - * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BRN` - Brazilian New Cruzado (1989–1990) - * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BRL` - Brazilian Real - * `GBP` - British Pound - * `BND` - Brunei Dollar - * `BGL` - Bulgarian Hard Lev - * `BGN` - Bulgarian Lev - * `BGO` - Bulgarian Lev (1879–1952) - * `BGM` - Bulgarian Socialist Lev - * `BUK` - Burmese Kyat - * `BIF` - Burundian Franc - * `XPF` - CFP Franc - * `KHR` - Cambodian Riel - * `CAD` - Canadian Dollar - * `CVE` - Cape Verdean Escudo - * `KYD` - Cayman Islands Dollar - * `XAF` - Central African CFA Franc - * `CLE` - Chilean Escudo - * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) - * `CNX` - Chinese People’s Bank Dollar - * `CNY` - Chinese Yuan - * `CNH` - Chinese Yuan (offshore) - * `COP` - Colombian Peso - * `COU` - Colombian Real Value Unit - * `KMF` - Comorian Franc - * `CDF` - Congolese Franc - * `CRC` - Costa Rican Colón - * `HRD` - Croatian Dinar - * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso - * `CUP` - Cuban Peso - * `CYP` - Cypriot Pound - * `CZK` - Czech Koruna - * `CSK` - Czechoslovak Hard Koruna - * `DKK` - Danish Krone - * `DJF` - Djiboutian Franc - * `DOP` - Dominican Peso - * `NLG` - Dutch Guilder - * `XCD` - East Caribbean Dollar - * `DDM` - East German Mark - * `ECS` - Ecuadorian Sucre - * `ECV` - Ecuadorian Unit of Constant Value - * `EGP` - Egyptian Pound - * `GQE` - Equatorial Guinean Ekwele - * `ERN` - Eritrean Nakfa - * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr - * `EUR` - Euro - * `XBA` - European Composite Unit - * `XEU` - European Currency Unit - * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) - * `XBD` - European Unit of Account (XBD) - * `FKP` - Falkland Islands Pound - * `FJD` - Fijian Dollar - * `FIM` - Finnish Markka - * `FRF` - French Franc - * `XFO` - French Gold Franc - * `XFU` - French UIC-Franc - * `GMD` - Gambian Dalasi - * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari - * `DEM` - German Mark - * `GHS` - Ghanaian Cedi - * `GHC` - Ghanaian Cedi (1979–2007) - * `GIP` - Gibraltar Pound - * `XAU` - Gold - * `GRD` - Greek Drachma - * `GTQ` - Guatemalan Quetzal - * `GWP` - Guinea-Bissau Peso - * `GNF` - Guinean Franc - * `GNS` - Guinean Syli - * `GYD` - Guyanaese Dollar - * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira - * `HKD` - Hong Kong Dollar - * `HUF` - Hungarian Forint - * `IMP` - IMP - * `ISK` - Icelandic Króna - * `ISJ` - Icelandic Króna (1918–1981) - * `INR` - Indian Rupee - * `IDR` - Indonesian Rupiah - * `IRR` - Iranian Rial - * `IQD` - Iraqi Dinar - * `IEP` - Irish Pound - * `ILS` - Israeli New Shekel - * `ILP` - Israeli Pound - * `ILR` - Israeli Shekel (1980–1985) - * `ITL` - Italian Lira - * `JMD` - Jamaican Dollar - * `JPY` - Japanese Yen - * `JOD` - Jordanian Dinar - * `KZT` - Kazakhstani Tenge - * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar - * `KGS` - Kyrgystani Som - * `LAK` - Laotian Kip - * `LVL` - Latvian Lats - * `LVR` - Latvian Ruble - * `LBP` - Lebanese Pound - * `LSL` - Lesotho Loti - * `LRD` - Liberian Dollar - * `LYD` - Libyan Dinar - * `LTL` - Lithuanian Litas - * `LTT` - Lithuanian Talonas - * `LUL` - Luxembourg Financial Franc - * `LUC` - Luxembourgian Convertible Franc - * `LUF` - Luxembourgian Franc - * `MOP` - Macanese Pataca - * `MKD` - Macedonian Denar - * `MKN` - Macedonian Denar (1992–1993) - * `MGA` - Malagasy Ariary - * `MGF` - Malagasy Franc - * `MWK` - Malawian Kwacha - * `MYR` - Malaysian Ringgit - * `MVR` - Maldivian Rufiyaa - * `MVP` - Maldivian Rupee (1947–1981) - * `MLF` - Malian Franc - * `MTL` - Maltese Lira - * `MTP` - Maltese Pound - * `MRU` - Mauritanian Ouguiya - * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MUR` - Mauritian Rupee - * `MXV` - Mexican Investment Unit - * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) - * `MDC` - Moldovan Cupon - * `MDL` - Moldovan Leu - * `MCF` - Monegasque Franc - * `MNT` - Mongolian Tugrik - * `MAD` - Moroccan Dirham - * `MAF` - Moroccan Franc - * `MZE` - Mozambican Escudo - * `MZN` - Mozambican Metical - * `MZM` - Mozambican Metical (1980–2006) - * `MMK` - Myanmar Kyat - * `NAD` - Namibian Dollar - * `NPR` - Nepalese Rupee - * `ANG` - Netherlands Antillean Guilder - * `TWD` - New Taiwan Dollar - * `NZD` - New Zealand Dollar - * `NIO` - Nicaraguan Córdoba - * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NGN` - Nigerian Naira - * `KPW` - North Korean Won - * `NOK` - Norwegian Krone - * `OMR` - Omani Rial - * `PKR` - Pakistani Rupee - * `XPD` - Palladium - * `PAB` - Panamanian Balboa - * `PGK` - Papua New Guinean Kina - * `PYG` - Paraguayan Guarani - * `PEI` - Peruvian Inti - * `PEN` - Peruvian Sol - * `PES` - Peruvian Sol (1863–1965) - * `PHP` - Philippine Peso - * `XPT` - Platinum - * `PLN` - Polish Zloty - * `PLZ` - Polish Zloty (1950–1995) - * `PTE` - Portuguese Escudo - * `GWE` - Portuguese Guinea Escudo - * `QAR` - Qatari Rial - * `XRE` - RINET Funds - * `RHD` - Rhodesian Dollar - * `RON` - Romanian Leu - * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble - * `RUR` - Russian Ruble (1991–1998) - * `RWF` - Rwandan Franc - * `SVC` - Salvadoran Colón - * `WST` - Samoan Tala - * `SAR` - Saudi Riyal - * `RSD` - Serbian Dinar - * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee - * `SLL` - Sierra Leonean Leone - * `XAG` - Silver - * `SGD` - Singapore Dollar - * `SKK` - Slovak Koruna - * `SIT` - Slovenian Tolar - * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling - * `ZAR` - South African Rand - * `ZAL` - South African Rand (financial) - * `KRH` - South Korean Hwan (1953–1962) - * `KRW` - South Korean Won - * `KRO` - South Korean Won (1945–1953) - * `SSP` - South Sudanese Pound - * `SUR` - Soviet Rouble - * `ESP` - Spanish Peseta - * `ESA` - Spanish Peseta (A account) - * `ESB` - Spanish Peseta (convertible account) - * `XDR` - Special Drawing Rights - * `LKR` - Sri Lankan Rupee - * `SHP` - St. Helena Pound - * `XSU` - Sucre - * `SDD` - Sudanese Dinar (1992–2007) - * `SDG` - Sudanese Pound - * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar - * `SRG` - Surinamese Guilder - * `SZL` - Swazi Lilangeni - * `SEK` - Swedish Krona - * `CHF` - Swiss Franc - * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `TVD` - TVD - * `TJR` - Tajikistani Ruble - * `TJS` - Tajikistani Somoni - * `TZS` - Tanzanian Shilling - * `XTS` - Testing Currency Code - * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is involved - * `TPE` - Timorese Escudo - * `TOP` - Tongan Paʻanga - * `TTD` - Trinidad & Tobago Dollar - * `TND` - Tunisian Dinar - * `TRY` - Turkish Lira - * `TRL` - Turkish Lira (1922–2005) - * `TMT` - Turkmenistani Manat - * `TMM` - Turkmenistani Manat (1993–2009) - * `USD` - US Dollar - * `USN` - US Dollar (Next day) - * `USS` - US Dollar (Same day) - * `UGX` - Ugandan Shilling - * `UGS` - Ugandan Shilling (1966–1987) - * `UAH` - Ukrainian Hryvnia - * `UAK` - Ukrainian Karbovanets - * `AED` - United Arab Emirates Dirham - * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYU` - Uruguayan Peso - * `UYP` - Uruguayan Peso (1975–1993) - * `UYI` - Uruguayan Peso (Indexed Units) - * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu - * `VES` - Venezuelan Bolívar - * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEF` - Venezuelan Bolívar (2008–2018) - * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro - * `CHW` - WIR Franc - * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN - * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRZ` - Zairean Zaire (1971–1993) - * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWR` - Zimbabwean Dollar (2008) - * `ZWL` - Zimbabwean Dollar (2009) - """ - + currency: typing.Optional[typing.Optional[typing.Any]] = None exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ Exchange rate used if the line item is in a foreign currency. diff --git a/src/merge/resources/accounting/types/expense_report_request.py b/src/merge/resources/accounting/types/expense_report_request.py index 00243adf..ca8c8b25 100644 --- a/src/merge/resources/accounting/types/expense_report_request.py +++ b/src/merge/resources/accounting/types/expense_report_request.py @@ -9,7 +9,7 @@ from .expense_report_request_accounting_period import ExpenseReportRequestAccountingPeriod from .expense_report_request_company import ExpenseReportRequestCompany from .expense_report_request_employee import ExpenseReportRequestEmployee -from .expense_report_status_enum import ExpenseReportStatusEnum +from .expense_report_request_status import ExpenseReportRequestStatus from .remote_field_request import RemoteFieldRequest from .transaction_currency_enum import TransactionCurrencyEnum @@ -40,7 +40,7 @@ class ExpenseReportRequest(UncheckedBaseModel): Identifier for the employee who submitted or is associated with the expense report """ - status: typing.Optional[ExpenseReportStatusEnum] = pydantic.Field(default=None) + status: typing.Optional[ExpenseReportRequestStatus] = pydantic.Field(default=None) """ Overall status of the expense report. One of DRAFT, SUBMITTED, APPROVED, REJECTED diff --git a/src/merge/resources/accounting/types/expense_report_request_status.py b/src/merge/resources/accounting/types/expense_report_request_status.py new file mode 100644 index 00000000..6fde38b5 --- /dev/null +++ b/src/merge/resources/accounting/types/expense_report_request_status.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .expense_report_status_enum import ExpenseReportStatusEnum + +ExpenseReportRequestStatus = typing.Union[ExpenseReportStatusEnum, str] diff --git a/src/merge/resources/accounting/types/patched_payment_request.py b/src/merge/resources/accounting/types/patched_payment_request.py index 7222862a..c6a47a90 100644 --- a/src/merge/resources/accounting/types/patched_payment_request.py +++ b/src/merge/resources/accounting/types/patched_payment_request.py @@ -9,7 +9,6 @@ from .patched_payment_request_account import PatchedPaymentRequestAccount from .patched_payment_request_accounting_period import PatchedPaymentRequestAccountingPeriod from .patched_payment_request_applied_to_lines_item import PatchedPaymentRequestAppliedToLinesItem -from .patched_payment_request_company import PatchedPaymentRequestCompany from .patched_payment_request_contact import PatchedPaymentRequestContact from .patched_payment_request_currency import PatchedPaymentRequestCurrency from .patched_payment_request_payment_method import PatchedPaymentRequestPaymentMethod @@ -365,7 +364,7 @@ class PatchedPaymentRequest(UncheckedBaseModel): The payment's exchange rate. """ - company: typing.Optional[PatchedPaymentRequestCompany] = pydantic.Field(default=None) + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the payment belongs to. """ diff --git a/src/merge/resources/accounting/types/payment_method.py b/src/merge/resources/accounting/types/payment_method.py index 0a3ec48d..7d4483d9 100644 --- a/src/merge/resources/accounting/types/payment_method.py +++ b/src/merge/resources/accounting/types/payment_method.py @@ -36,7 +36,7 @@ class PaymentMethod(UncheckedBaseModel): The datetime that this object was modified by Merge. """ - method_type: PaymentMethodMethodType = pydantic.Field() + method_type: typing.Optional[PaymentMethodMethodType] = pydantic.Field(default=None) """ The type of the payment method. diff --git a/src/merge/resources/accounting/types/purchase_order_request.py b/src/merge/resources/accounting/types/purchase_order_request.py index 95fa1a1e..d71ab44a 100644 --- a/src/merge/resources/accounting/types/purchase_order_request.py +++ b/src/merge/resources/accounting/types/purchase_order_request.py @@ -8,7 +8,6 @@ from ....core.unchecked_base_model import UncheckedBaseModel from .purchase_order_line_item_request import PurchaseOrderLineItemRequest from .purchase_order_request_company import PurchaseOrderRequestCompany -from .purchase_order_request_currency import PurchaseOrderRequestCurrency from .purchase_order_request_delivery_address import PurchaseOrderRequestDeliveryAddress from .purchase_order_request_payment_term import PurchaseOrderRequestPaymentTerm from .purchase_order_request_status import PurchaseOrderRequestStatus @@ -83,318 +82,7 @@ class PurchaseOrderRequest(UncheckedBaseModel): The payment term that applies to this transaction. """ - currency: typing.Optional[PurchaseOrderRequestCurrency] = pydantic.Field(default=None) - """ - The purchase order's currency. - - * `XUA` - ADB Unit of Account - * `AFN` - Afghan Afghani - * `AFA` - Afghan Afghani (1927–2002) - * `ALL` - Albanian Lek - * `ALK` - Albanian Lek (1946–1965) - * `DZD` - Algerian Dinar - * `ADP` - Andorran Peseta - * `AOA` - Angolan Kwanza - * `AOK` - Angolan Kwanza (1977–1991) - * `AON` - Angolan New Kwanza (1990–2000) - * `AOR` - Angolan Readjusted Kwanza (1995–1999) - * `ARA` - Argentine Austral - * `ARS` - Argentine Peso - * `ARM` - Argentine Peso (1881–1970) - * `ARP` - Argentine Peso (1983–1985) - * `ARL` - Argentine Peso Ley (1970–1983) - * `AMD` - Armenian Dram - * `AWG` - Aruban Florin - * `AUD` - Australian Dollar - * `ATS` - Austrian Schilling - * `AZN` - Azerbaijani Manat - * `AZM` - Azerbaijani Manat (1993–2006) - * `BSD` - Bahamian Dollar - * `BHD` - Bahraini Dinar - * `BDT` - Bangladeshi Taka - * `BBD` - Barbadian Dollar - * `BYN` - Belarusian Ruble - * `BYB` - Belarusian Ruble (1994–1999) - * `BYR` - Belarusian Ruble (2000–2016) - * `BEF` - Belgian Franc - * `BEC` - Belgian Franc (convertible) - * `BEL` - Belgian Franc (financial) - * `BZD` - Belize Dollar - * `BMD` - Bermudan Dollar - * `BTN` - Bhutanese Ngultrum - * `BOB` - Bolivian Boliviano - * `BOL` - Bolivian Boliviano (1863–1963) - * `BOV` - Bolivian Mvdol - * `BOP` - Bolivian Peso - * `BAM` - Bosnia-Herzegovina Convertible Mark - * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) - * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) - * `BWP` - Botswanan Pula - * `BRC` - Brazilian Cruzado (1986–1989) - * `BRZ` - Brazilian Cruzeiro (1942–1967) - * `BRE` - Brazilian Cruzeiro (1990–1993) - * `BRR` - Brazilian Cruzeiro (1993–1994) - * `BRN` - Brazilian New Cruzado (1989–1990) - * `BRB` - Brazilian New Cruzeiro (1967–1986) - * `BRL` - Brazilian Real - * `GBP` - British Pound - * `BND` - Brunei Dollar - * `BGL` - Bulgarian Hard Lev - * `BGN` - Bulgarian Lev - * `BGO` - Bulgarian Lev (1879–1952) - * `BGM` - Bulgarian Socialist Lev - * `BUK` - Burmese Kyat - * `BIF` - Burundian Franc - * `XPF` - CFP Franc - * `KHR` - Cambodian Riel - * `CAD` - Canadian Dollar - * `CVE` - Cape Verdean Escudo - * `KYD` - Cayman Islands Dollar - * `XAF` - Central African CFA Franc - * `CLE` - Chilean Escudo - * `CLP` - Chilean Peso - * `CLF` - Chilean Unit of Account (UF) - * `CNX` - Chinese People’s Bank Dollar - * `CNY` - Chinese Yuan - * `CNH` - Chinese Yuan (offshore) - * `COP` - Colombian Peso - * `COU` - Colombian Real Value Unit - * `KMF` - Comorian Franc - * `CDF` - Congolese Franc - * `CRC` - Costa Rican Colón - * `HRD` - Croatian Dinar - * `HRK` - Croatian Kuna - * `CUC` - Cuban Convertible Peso - * `CUP` - Cuban Peso - * `CYP` - Cypriot Pound - * `CZK` - Czech Koruna - * `CSK` - Czechoslovak Hard Koruna - * `DKK` - Danish Krone - * `DJF` - Djiboutian Franc - * `DOP` - Dominican Peso - * `NLG` - Dutch Guilder - * `XCD` - East Caribbean Dollar - * `DDM` - East German Mark - * `ECS` - Ecuadorian Sucre - * `ECV` - Ecuadorian Unit of Constant Value - * `EGP` - Egyptian Pound - * `GQE` - Equatorial Guinean Ekwele - * `ERN` - Eritrean Nakfa - * `EEK` - Estonian Kroon - * `ETB` - Ethiopian Birr - * `EUR` - Euro - * `XBA` - European Composite Unit - * `XEU` - European Currency Unit - * `XBB` - European Monetary Unit - * `XBC` - European Unit of Account (XBC) - * `XBD` - European Unit of Account (XBD) - * `FKP` - Falkland Islands Pound - * `FJD` - Fijian Dollar - * `FIM` - Finnish Markka - * `FRF` - French Franc - * `XFO` - French Gold Franc - * `XFU` - French UIC-Franc - * `GMD` - Gambian Dalasi - * `GEK` - Georgian Kupon Larit - * `GEL` - Georgian Lari - * `DEM` - German Mark - * `GHS` - Ghanaian Cedi - * `GHC` - Ghanaian Cedi (1979–2007) - * `GIP` - Gibraltar Pound - * `XAU` - Gold - * `GRD` - Greek Drachma - * `GTQ` - Guatemalan Quetzal - * `GWP` - Guinea-Bissau Peso - * `GNF` - Guinean Franc - * `GNS` - Guinean Syli - * `GYD` - Guyanaese Dollar - * `HTG` - Haitian Gourde - * `HNL` - Honduran Lempira - * `HKD` - Hong Kong Dollar - * `HUF` - Hungarian Forint - * `IMP` - IMP - * `ISK` - Icelandic Króna - * `ISJ` - Icelandic Króna (1918–1981) - * `INR` - Indian Rupee - * `IDR` - Indonesian Rupiah - * `IRR` - Iranian Rial - * `IQD` - Iraqi Dinar - * `IEP` - Irish Pound - * `ILS` - Israeli New Shekel - * `ILP` - Israeli Pound - * `ILR` - Israeli Shekel (1980–1985) - * `ITL` - Italian Lira - * `JMD` - Jamaican Dollar - * `JPY` - Japanese Yen - * `JOD` - Jordanian Dinar - * `KZT` - Kazakhstani Tenge - * `KES` - Kenyan Shilling - * `KWD` - Kuwaiti Dinar - * `KGS` - Kyrgystani Som - * `LAK` - Laotian Kip - * `LVL` - Latvian Lats - * `LVR` - Latvian Ruble - * `LBP` - Lebanese Pound - * `LSL` - Lesotho Loti - * `LRD` - Liberian Dollar - * `LYD` - Libyan Dinar - * `LTL` - Lithuanian Litas - * `LTT` - Lithuanian Talonas - * `LUL` - Luxembourg Financial Franc - * `LUC` - Luxembourgian Convertible Franc - * `LUF` - Luxembourgian Franc - * `MOP` - Macanese Pataca - * `MKD` - Macedonian Denar - * `MKN` - Macedonian Denar (1992–1993) - * `MGA` - Malagasy Ariary - * `MGF` - Malagasy Franc - * `MWK` - Malawian Kwacha - * `MYR` - Malaysian Ringgit - * `MVR` - Maldivian Rufiyaa - * `MVP` - Maldivian Rupee (1947–1981) - * `MLF` - Malian Franc - * `MTL` - Maltese Lira - * `MTP` - Maltese Pound - * `MRU` - Mauritanian Ouguiya - * `MRO` - Mauritanian Ouguiya (1973–2017) - * `MUR` - Mauritian Rupee - * `MXV` - Mexican Investment Unit - * `MXN` - Mexican Peso - * `MXP` - Mexican Silver Peso (1861–1992) - * `MDC` - Moldovan Cupon - * `MDL` - Moldovan Leu - * `MCF` - Monegasque Franc - * `MNT` - Mongolian Tugrik - * `MAD` - Moroccan Dirham - * `MAF` - Moroccan Franc - * `MZE` - Mozambican Escudo - * `MZN` - Mozambican Metical - * `MZM` - Mozambican Metical (1980–2006) - * `MMK` - Myanmar Kyat - * `NAD` - Namibian Dollar - * `NPR` - Nepalese Rupee - * `ANG` - Netherlands Antillean Guilder - * `TWD` - New Taiwan Dollar - * `NZD` - New Zealand Dollar - * `NIO` - Nicaraguan Córdoba - * `NIC` - Nicaraguan Córdoba (1988–1991) - * `NGN` - Nigerian Naira - * `KPW` - North Korean Won - * `NOK` - Norwegian Krone - * `OMR` - Omani Rial - * `PKR` - Pakistani Rupee - * `XPD` - Palladium - * `PAB` - Panamanian Balboa - * `PGK` - Papua New Guinean Kina - * `PYG` - Paraguayan Guarani - * `PEI` - Peruvian Inti - * `PEN` - Peruvian Sol - * `PES` - Peruvian Sol (1863–1965) - * `PHP` - Philippine Peso - * `XPT` - Platinum - * `PLN` - Polish Zloty - * `PLZ` - Polish Zloty (1950–1995) - * `PTE` - Portuguese Escudo - * `GWE` - Portuguese Guinea Escudo - * `QAR` - Qatari Rial - * `XRE` - RINET Funds - * `RHD` - Rhodesian Dollar - * `RON` - Romanian Leu - * `ROL` - Romanian Leu (1952–2006) - * `RUB` - Russian Ruble - * `RUR` - Russian Ruble (1991–1998) - * `RWF` - Rwandan Franc - * `SVC` - Salvadoran Colón - * `WST` - Samoan Tala - * `SAR` - Saudi Riyal - * `RSD` - Serbian Dinar - * `CSD` - Serbian Dinar (2002–2006) - * `SCR` - Seychellois Rupee - * `SLL` - Sierra Leonean Leone - * `XAG` - Silver - * `SGD` - Singapore Dollar - * `SKK` - Slovak Koruna - * `SIT` - Slovenian Tolar - * `SBD` - Solomon Islands Dollar - * `SOS` - Somali Shilling - * `ZAR` - South African Rand - * `ZAL` - South African Rand (financial) - * `KRH` - South Korean Hwan (1953–1962) - * `KRW` - South Korean Won - * `KRO` - South Korean Won (1945–1953) - * `SSP` - South Sudanese Pound - * `SUR` - Soviet Rouble - * `ESP` - Spanish Peseta - * `ESA` - Spanish Peseta (A account) - * `ESB` - Spanish Peseta (convertible account) - * `XDR` - Special Drawing Rights - * `LKR` - Sri Lankan Rupee - * `SHP` - St. Helena Pound - * `XSU` - Sucre - * `SDD` - Sudanese Dinar (1992–2007) - * `SDG` - Sudanese Pound - * `SDP` - Sudanese Pound (1957–1998) - * `SRD` - Surinamese Dollar - * `SRG` - Surinamese Guilder - * `SZL` - Swazi Lilangeni - * `SEK` - Swedish Krona - * `CHF` - Swiss Franc - * `SYP` - Syrian Pound - * `STN` - São Tomé & Príncipe Dobra - * `STD` - São Tomé & Príncipe Dobra (1977–2017) - * `TVD` - TVD - * `TJR` - Tajikistani Ruble - * `TJS` - Tajikistani Somoni - * `TZS` - Tanzanian Shilling - * `XTS` - Testing Currency Code - * `THB` - Thai Baht - * `XXX` - The codes assigned for transactions where no currency is involved - * `TPE` - Timorese Escudo - * `TOP` - Tongan Paʻanga - * `TTD` - Trinidad & Tobago Dollar - * `TND` - Tunisian Dinar - * `TRY` - Turkish Lira - * `TRL` - Turkish Lira (1922–2005) - * `TMT` - Turkmenistani Manat - * `TMM` - Turkmenistani Manat (1993–2009) - * `USD` - US Dollar - * `USN` - US Dollar (Next day) - * `USS` - US Dollar (Same day) - * `UGX` - Ugandan Shilling - * `UGS` - Ugandan Shilling (1966–1987) - * `UAH` - Ukrainian Hryvnia - * `UAK` - Ukrainian Karbovanets - * `AED` - United Arab Emirates Dirham - * `UYW` - Uruguayan Nominal Wage Index Unit - * `UYU` - Uruguayan Peso - * `UYP` - Uruguayan Peso (1975–1993) - * `UYI` - Uruguayan Peso (Indexed Units) - * `UZS` - Uzbekistani Som - * `VUV` - Vanuatu Vatu - * `VES` - Venezuelan Bolívar - * `VEB` - Venezuelan Bolívar (1871–2008) - * `VEF` - Venezuelan Bolívar (2008–2018) - * `VND` - Vietnamese Dong - * `VNN` - Vietnamese Dong (1978–1985) - * `CHE` - WIR Euro - * `CHW` - WIR Franc - * `XOF` - West African CFA Franc - * `YDD` - Yemeni Dinar - * `YER` - Yemeni Rial - * `YUN` - Yugoslavian Convertible Dinar (1990–1992) - * `YUD` - Yugoslavian Hard Dinar (1966–1990) - * `YUM` - Yugoslavian New Dinar (1994–2002) - * `YUR` - Yugoslavian Reformed Dinar (1992–1993) - * `ZWN` - ZWN - * `ZRN` - Zairean New Zaire (1993–1998) - * `ZRZ` - Zairean Zaire (1971–1993) - * `ZMW` - Zambian Kwacha - * `ZMK` - Zambian Kwacha (1968–2012) - * `ZWD` - Zimbabwean Dollar (1980–2008) - * `ZWR` - Zimbabwean Dollar (2008) - * `ZWL` - Zimbabwean Dollar (2009) - """ - + currency: typing.Optional[typing.Optional[typing.Any]] = None inclusive_of_tax: typing.Optional[bool] = pydantic.Field(default=None) """ If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. diff --git a/src/merge/resources/accounting/types/purchase_order_request_currency.py b/src/merge/resources/accounting/types/purchase_order_request_currency.py deleted file mode 100644 index 082e4654..00000000 --- a/src/merge/resources/accounting/types/purchase_order_request_currency.py +++ /dev/null @@ -1,7 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -from .transaction_currency_enum import TransactionCurrencyEnum - -PurchaseOrderRequestCurrency = typing.Union[TransactionCurrencyEnum, str] diff --git a/src/merge/resources/accounting/types/remote_field_class.py b/src/merge/resources/accounting/types/remote_field_class.py index e5672719..4126b4e7 100644 --- a/src/merge/resources/accounting/types/remote_field_class.py +++ b/src/merge/resources/accounting/types/remote_field_class.py @@ -16,6 +16,7 @@ class RemoteFieldClass(UncheckedBaseModel): remote_key_name: typing.Optional[str] = None description: typing.Optional[str] = None is_custom: typing.Optional[bool] = None + is_common_model_field: typing.Optional[bool] = None is_required: typing.Optional[bool] = None field_type: typing.Optional[FieldTypeEnum] = None field_format: typing.Optional[FieldFormatEnum] = None diff --git a/src/merge/resources/accounting/types/sync_status.py b/src/merge/resources/accounting/types/sync_status.py index ca6a53b0..07ab1dc2 100644 --- a/src/merge/resources/accounting/types/sync_status.py +++ b/src/merge/resources/accounting/types/sync_status.py @@ -6,8 +6,8 @@ import pydantic from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel -from .last_sync_result_enum import LastSyncResultEnum from .selective_sync_configurations_usage_enum import SelectiveSyncConfigurationsUsageEnum +from .sync_status_last_sync_result import SyncStatusLastSyncResult from .sync_status_status import SyncStatusStatus @@ -25,7 +25,7 @@ class SyncStatus(UncheckedBaseModel): model_id: str last_sync_start: typing.Optional[dt.datetime] = None next_sync_start: typing.Optional[dt.datetime] = None - last_sync_result: typing.Optional[LastSyncResultEnum] = None + last_sync_result: typing.Optional[SyncStatusLastSyncResult] = None last_sync_finished: typing.Optional[dt.datetime] = None status: SyncStatusStatus is_initial_sync: bool diff --git a/src/merge/resources/accounting/types/sync_status_last_sync_result.py b/src/merge/resources/accounting/types/sync_status_last_sync_result.py new file mode 100644 index 00000000..980e7d94 --- /dev/null +++ b/src/merge/resources/accounting/types/sync_status_last_sync_result.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .last_sync_result_enum import LastSyncResultEnum + +SyncStatusLastSyncResult = typing.Union[LastSyncResultEnum, str] diff --git a/src/merge/resources/accounting/types/transaction.py b/src/merge/resources/accounting/types/transaction.py index 9a014736..885dcd8d 100644 --- a/src/merge/resources/accounting/types/transaction.py +++ b/src/merge/resources/accounting/types/transaction.py @@ -9,6 +9,7 @@ from .remote_data import RemoteData from .transaction_account import TransactionAccount from .transaction_accounting_period import TransactionAccountingPeriod +from .transaction_company import TransactionCompany from .transaction_contact import TransactionContact from .transaction_currency import TransactionCurrency from .transaction_line_item import TransactionLineItem @@ -400,7 +401,7 @@ class Transaction(UncheckedBaseModel): The transaction's exchange rate. """ - company: typing.Optional[str] = pydantic.Field(default=None) + company: typing.Optional[TransactionCompany] = pydantic.Field(default=None) """ The company the transaction belongs to. """ diff --git a/src/merge/resources/accounting/types/patched_payment_request_company.py b/src/merge/resources/accounting/types/transaction_company.py similarity index 65% rename from src/merge/resources/accounting/types/patched_payment_request_company.py rename to src/merge/resources/accounting/types/transaction_company.py index 46869369..fd5f0055 100644 --- a/src/merge/resources/accounting/types/patched_payment_request_company.py +++ b/src/merge/resources/accounting/types/transaction_company.py @@ -4,4 +4,4 @@ from .company_info import CompanyInfo -PatchedPaymentRequestCompany = typing.Union[str, CompanyInfo] +TransactionCompany = typing.Union[str, CompanyInfo] diff --git a/src/merge/resources/accounting/types/vendor_credit.py b/src/merge/resources/accounting/types/vendor_credit.py index 21467ced..b99c8e41 100644 --- a/src/merge/resources/accounting/types/vendor_credit.py +++ b/src/merge/resources/accounting/types/vendor_credit.py @@ -12,7 +12,7 @@ from .vendor_credit_accounting_period import VendorCreditAccountingPeriod from .vendor_credit_company import VendorCreditCompany from .vendor_credit_currency import VendorCreditCurrency -from .vendor_credit_line import VendorCreditLine +from .vendor_credit_lines_item import VendorCreditLinesItem from .vendor_credit_tracking_categories_item import VendorCreditTrackingCategoriesItem from .vendor_credit_vendor import VendorCreditVendor @@ -390,7 +390,7 @@ class VendorCredit(UncheckedBaseModel): The company the vendor credit belongs to. """ - lines: typing.Optional[typing.List[VendorCreditLine]] = None + lines: typing.Optional[typing.List[VendorCreditLinesItem]] = None tracking_categories: typing.Optional[typing.List[typing.Optional[VendorCreditTrackingCategoriesItem]]] = None applied_to_lines: typing.Optional[typing.List["VendorCreditApplyLineForVendorCredit"]] = pydantic.Field( default=None diff --git a/src/merge/resources/accounting/types/vendor_credit_lines_item.py b/src/merge/resources/accounting/types/vendor_credit_lines_item.py new file mode 100644 index 00000000..a86d3edd --- /dev/null +++ b/src/merge/resources/accounting/types/vendor_credit_lines_item.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .vendor_credit_line import VendorCreditLine + +VendorCreditLinesItem = typing.Union[typing.Optional[typing.Any], VendorCreditLine] diff --git a/src/merge/resources/ats/resources/activities/client.py b/src/merge/resources/ats/resources/activities/client.py index 4ce5438b..b3070acf 100644 --- a/src/merge/resources/ats/resources/activities/client.py +++ b/src/merge/resources/ats/resources/activities/client.py @@ -117,7 +117,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.activities.list() + client.ats.activities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -387,7 +389,9 @@ async def list( async def main() -> None: - await client.ats.activities.list() + await client.ats.activities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/applications/client.py b/src/merge/resources/ats/resources/applications/client.py index 36f211ba..e4f5f142 100644 --- a/src/merge/resources/ats/resources/applications/client.py +++ b/src/merge/resources/ats/resources/applications/client.py @@ -127,7 +127,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.applications.list() + client.ats.applications.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( candidate_id=candidate_id, @@ -473,7 +475,9 @@ async def list( async def main() -> None: - await client.ats.applications.list() + await client.ats.applications.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/attachments/client.py b/src/merge/resources/ats/resources/attachments/client.py index 02e1d145..ba606803 100644 --- a/src/merge/resources/ats/resources/attachments/client.py +++ b/src/merge/resources/ats/resources/attachments/client.py @@ -113,7 +113,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.attachments.list() + client.ats.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( candidate_id=candidate_id, @@ -383,7 +385,9 @@ async def list( async def main() -> None: - await client.ats.attachments.list() + await client.ats.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/audit_trail/client.py b/src/merge/resources/ats/resources/audit_trail/client.py index 51f2e0df..a9942a91 100644 --- a/src/merge/resources/ats/resources/audit_trail/client.py +++ b/src/merge/resources/ats/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.audit_trail.list() + client.ats.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.ats.audit_trail.list() + await client.ats.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/candidates/client.py b/src/merge/resources/ats/resources/candidates/client.py index 418b1d66..434b18a1 100644 --- a/src/merge/resources/ats/resources/candidates/client.py +++ b/src/merge/resources/ats/resources/candidates/client.py @@ -121,7 +121,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.candidates.list() + client.ats.candidates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -522,7 +524,9 @@ async def list( async def main() -> None: - await client.ats.candidates.list() + await client.ats.candidates.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/departments/client.py b/src/merge/resources/ats/resources/departments/client.py index 549ad189..d543959c 100644 --- a/src/merge/resources/ats/resources/departments/client.py +++ b/src/merge/resources/ats/resources/departments/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.departments.list() + client.ats.departments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ats.departments.list() + await client.ats.departments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/eeocs/client.py b/src/merge/resources/ats/resources/eeocs/client.py index 7c83afcb..4a848651 100644 --- a/src/merge/resources/ats/resources/eeocs/client.py +++ b/src/merge/resources/ats/resources/eeocs/client.py @@ -111,7 +111,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.eeocs.list() + client.ats.eeocs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( candidate_id=candidate_id, @@ -299,7 +301,9 @@ async def list( async def main() -> None: - await client.ats.eeocs.list() + await client.ats.eeocs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/interviews/client.py b/src/merge/resources/ats/resources/interviews/client.py index 9330c06e..9acbef5c 100644 --- a/src/merge/resources/ats/resources/interviews/client.py +++ b/src/merge/resources/ats/resources/interviews/client.py @@ -127,7 +127,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.interviews.list() + client.ats.interviews.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( application_id=application_id, @@ -412,7 +414,9 @@ async def list( async def main() -> None: - await client.ats.interviews.list() + await client.ats.interviews.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/issues/client.py b/src/merge/resources/ats/resources/issues/client.py index 07cdb53b..c429339f 100644 --- a/src/merge/resources/ats/resources/issues/client.py +++ b/src/merge/resources/ats/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.issues.list() + client.ats.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.ats.issues.list() + await client.ats.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/job_interview_stages/client.py b/src/merge/resources/ats/resources/job_interview_stages/client.py index 1133af8e..9dbb31c6 100644 --- a/src/merge/resources/ats/resources/job_interview_stages/client.py +++ b/src/merge/resources/ats/resources/job_interview_stages/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.job_interview_stages.list() + client.ats.job_interview_stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.ats.job_interview_stages.list() + await client.ats.job_interview_stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/job_postings/client.py b/src/merge/resources/ats/resources/job_postings/client.py index eec24b7e..7187c098 100644 --- a/src/merge/resources/ats/resources/job_postings/client.py +++ b/src/merge/resources/ats/resources/job_postings/client.py @@ -106,7 +106,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.job_postings.list() + client.ats.job_postings.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -280,7 +282,9 @@ async def list( async def main() -> None: - await client.ats.job_postings.list() + await client.ats.job_postings.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/jobs/client.py b/src/merge/resources/ats/resources/jobs/client.py index 73d353e0..1dc28a48 100644 --- a/src/merge/resources/ats/resources/jobs/client.py +++ b/src/merge/resources/ats/resources/jobs/client.py @@ -126,7 +126,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.jobs.list() + client.ats.jobs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( code=code, @@ -268,6 +270,7 @@ def screening_questions_list( ) client.ats.jobs.screening_questions_list( job_id="job_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.screening_questions_list( @@ -399,7 +402,9 @@ async def list( async def main() -> None: - await client.ats.jobs.list() + await client.ats.jobs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -557,6 +562,7 @@ async def screening_questions_list( async def main() -> None: await client.ats.jobs.screening_questions_list( job_id="job_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/ats/resources/linked_accounts/client.py b/src/merge/resources/ats/resources/linked_accounts/client.py index cd72d270..d11c05c4 100644 --- a/src/merge/resources/ats/resources/linked_accounts/client.py +++ b/src/merge/resources/ats/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.linked_accounts.list() + client.ats.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.ats.linked_accounts.list() + await client.ats.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/offers/client.py b/src/merge/resources/ats/resources/offers/client.py index 910b32ad..4737bf2e 100644 --- a/src/merge/resources/ats/resources/offers/client.py +++ b/src/merge/resources/ats/resources/offers/client.py @@ -113,7 +113,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.offers.list() + client.ats.offers.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( application_id=application_id, @@ -306,7 +308,9 @@ async def list( async def main() -> None: - await client.ats.offers.list() + await client.ats.offers.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/offices/client.py b/src/merge/resources/ats/resources/offices/client.py index 323998d6..173aa017 100644 --- a/src/merge/resources/ats/resources/offices/client.py +++ b/src/merge/resources/ats/resources/offices/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.offices.list() + client.ats.offices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ats.offices.list() + await client.ats.offices.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/reject_reasons/client.py b/src/merge/resources/ats/resources/reject_reasons/client.py index 36cf953e..107fb931 100644 --- a/src/merge/resources/ats/resources/reject_reasons/client.py +++ b/src/merge/resources/ats/resources/reject_reasons/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.reject_reasons.list() + client.ats.reject_reasons.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ats.reject_reasons.list() + await client.ats.reject_reasons.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/scorecards/client.py b/src/merge/resources/ats/resources/scorecards/client.py index 0df3750e..d24fa3cf 100644 --- a/src/merge/resources/ats/resources/scorecards/client.py +++ b/src/merge/resources/ats/resources/scorecards/client.py @@ -117,7 +117,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.scorecards.list() + client.ats.scorecards.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( application_id=application_id, @@ -315,7 +317,9 @@ async def list( async def main() -> None: - await client.ats.scorecards.list() + await client.ats.scorecards.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/sync_status/client.py b/src/merge/resources/ats/resources/sync_status/client.py index c87a7fcd..7eebd768 100644 --- a/src/merge/resources/ats/resources/sync_status/client.py +++ b/src/merge/resources/ats/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.sync_status.list() + client.ats.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.ats.sync_status.list() + await client.ats.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/tags/client.py b/src/merge/resources/ats/resources/tags/client.py index 8e447a7d..9aa39684 100644 --- a/src/merge/resources/ats/resources/tags/client.py +++ b/src/merge/resources/ats/resources/tags/client.py @@ -90,7 +90,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.tags.list() + client.ats.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -194,7 +196,9 @@ async def list( async def main() -> None: - await client.ats.tags.list() + await client.ats.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/resources/users/client.py b/src/merge/resources/ats/resources/users/client.py index b09b7e5b..0046a79f 100644 --- a/src/merge/resources/ats/resources/users/client.py +++ b/src/merge/resources/ats/resources/users/client.py @@ -103,7 +103,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ats.users.list() + client.ats.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -281,7 +283,9 @@ async def list( async def main() -> None: - await client.ats.users.list() + await client.ats.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ats/types/event_type_enum.py b/src/merge/resources/ats/types/event_type_enum.py index 6f6f1476..537cea3f 100644 --- a/src/merge/resources/ats/types/event_type_enum.py +++ b/src/merge/resources/ats/types/event_type_enum.py @@ -58,6 +58,7 @@ class EventTypeEnum(str, enum.Enum): CREATED_TEST_API_KEY = "CREATED_TEST_API_KEY" DELETED_TEST_API_KEY = "DELETED_TEST_API_KEY" REGENERATED_PRODUCTION_API_KEY = "REGENERATED_PRODUCTION_API_KEY" + REGENERATED_WEBHOOK_SIGNATURE = "REGENERATED_WEBHOOK_SIGNATURE" INVITED_USER = "INVITED_USER" TWO_FACTOR_AUTH_ENABLED = "TWO_FACTOR_AUTH_ENABLED" TWO_FACTOR_AUTH_DISABLED = "TWO_FACTOR_AUTH_DISABLED" @@ -103,6 +104,7 @@ def visit( created_test_api_key: typing.Callable[[], T_Result], deleted_test_api_key: typing.Callable[[], T_Result], regenerated_production_api_key: typing.Callable[[], T_Result], + regenerated_webhook_signature: typing.Callable[[], T_Result], invited_user: typing.Callable[[], T_Result], two_factor_auth_enabled: typing.Callable[[], T_Result], two_factor_auth_disabled: typing.Callable[[], T_Result], @@ -151,6 +153,8 @@ def visit( return deleted_test_api_key() if self is EventTypeEnum.REGENERATED_PRODUCTION_API_KEY: return regenerated_production_api_key() + if self is EventTypeEnum.REGENERATED_WEBHOOK_SIGNATURE: + return regenerated_webhook_signature() if self is EventTypeEnum.INVITED_USER: return invited_user() if self is EventTypeEnum.TWO_FACTOR_AUTH_ENABLED: diff --git a/src/merge/resources/crm/resources/accounts/client.py b/src/merge/resources/crm/resources/accounts/client.py index b8b90549..88508090 100644 --- a/src/merge/resources/crm/resources/accounts/client.py +++ b/src/merge/resources/crm/resources/accounts/client.py @@ -115,7 +115,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.accounts.list() + client.crm.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -409,7 +411,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.accounts.remote_field_classes_list() + client.crm.accounts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -527,7 +531,9 @@ async def list( async def main() -> None: - await client.crm.accounts.list() + await client.crm.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -871,7 +877,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.accounts.remote_field_classes_list() + await client.crm.accounts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/association_types/client.py b/src/merge/resources/crm/resources/association_types/client.py index b58c597e..cb747530 100644 --- a/src/merge/resources/crm/resources/association_types/client.py +++ b/src/merge/resources/crm/resources/association_types/client.py @@ -106,6 +106,7 @@ def custom_object_classes_association_types_list( ) client.crm.association_types.custom_object_classes_association_types_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.custom_object_classes_association_types_list( @@ -386,6 +387,7 @@ async def custom_object_classes_association_types_list( async def main() -> None: await client.crm.association_types.custom_object_classes_association_types_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/crm/resources/associations/client.py b/src/merge/resources/crm/resources/associations/client.py index 7591b917..e2d95ae8 100644 --- a/src/merge/resources/crm/resources/associations/client.py +++ b/src/merge/resources/crm/resources/associations/client.py @@ -108,6 +108,7 @@ def custom_object_classes_custom_objects_associations_list( client.crm.associations.custom_object_classes_custom_objects_associations_list( custom_object_class_id="custom_object_class_id", object_id="object_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.custom_object_classes_custom_objects_associations_list( @@ -302,6 +303,7 @@ async def main() -> None: await client.crm.associations.custom_object_classes_custom_objects_associations_list( custom_object_class_id="custom_object_class_id", object_id="object_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/crm/resources/audit_trail/client.py b/src/merge/resources/crm/resources/audit_trail/client.py index ec2a114a..71e19cdb 100644 --- a/src/merge/resources/crm/resources/audit_trail/client.py +++ b/src/merge/resources/crm/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.audit_trail.list() + client.crm.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.crm.audit_trail.list() + await client.crm.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/contacts/client.py b/src/merge/resources/crm/resources/contacts/client.py index 6359a159..a51b2f47 100644 --- a/src/merge/resources/crm/resources/contacts/client.py +++ b/src/merge/resources/crm/resources/contacts/client.py @@ -122,7 +122,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.contacts.list() + client.crm.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -459,7 +461,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.contacts.remote_field_classes_list() + client.crm.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -581,7 +585,9 @@ async def list( async def main() -> None: - await client.crm.contacts.list() + await client.crm.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -976,7 +982,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.contacts.remote_field_classes_list() + await client.crm.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/custom_object_classes/client.py b/src/merge/resources/crm/resources/custom_object_classes/client.py index eedd7490..9289295c 100644 --- a/src/merge/resources/crm/resources/custom_object_classes/client.py +++ b/src/merge/resources/crm/resources/custom_object_classes/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.custom_object_classes.list() + client.crm.custom_object_classes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -258,7 +260,9 @@ async def list( async def main() -> None: - await client.crm.custom_object_classes.list() + await client.crm.custom_object_classes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/custom_objects/client.py b/src/merge/resources/crm/resources/custom_objects/client.py index aeb76cc5..41354143 100644 --- a/src/merge/resources/crm/resources/custom_objects/client.py +++ b/src/merge/resources/crm/resources/custom_objects/client.py @@ -107,6 +107,7 @@ def custom_object_classes_custom_objects_list( ) client.crm.custom_objects.custom_object_classes_custom_objects_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.custom_object_classes_custom_objects_list( @@ -335,7 +336,9 @@ def custom_object_classes_custom_objects_remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list() + client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.custom_object_classes_custom_objects_remote_field_classes_list( cursor=cursor, @@ -446,6 +449,7 @@ async def custom_object_classes_custom_objects_list( async def main() -> None: await client.crm.custom_objects.custom_object_classes_custom_objects_list( custom_object_class_id="custom_object_class_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -706,7 +710,9 @@ async def custom_object_classes_custom_objects_remote_field_classes_list( async def main() -> None: - await client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list() + await client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/engagement_types/client.py b/src/merge/resources/crm/resources/engagement_types/client.py index 2535a49e..df7faa0f 100644 --- a/src/merge/resources/crm/resources/engagement_types/client.py +++ b/src/merge/resources/crm/resources/engagement_types/client.py @@ -96,7 +96,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.engagement_types.list() + client.crm.engagement_types.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -226,7 +228,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.engagement_types.remote_field_classes_list() + client.crm.engagement_types.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -332,7 +336,9 @@ async def list( async def main() -> None: - await client.crm.engagement_types.list() + await client.crm.engagement_types.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -478,7 +484,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.engagement_types.remote_field_classes_list() + await client.crm.engagement_types.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/engagements/client.py b/src/merge/resources/crm/resources/engagements/client.py index 0bc28fd7..42174adf 100644 --- a/src/merge/resources/crm/resources/engagements/client.py +++ b/src/merge/resources/crm/resources/engagements/client.py @@ -117,7 +117,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.engagements.list() + client.crm.engagements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -411,7 +413,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.engagements.remote_field_classes_list() + client.crm.engagements.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -529,7 +533,9 @@ async def list( async def main() -> None: - await client.crm.engagements.list() + await client.crm.engagements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -873,7 +879,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.engagements.remote_field_classes_list() + await client.crm.engagements.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/issues/client.py b/src/merge/resources/crm/resources/issues/client.py index e967f73c..a9237e53 100644 --- a/src/merge/resources/crm/resources/issues/client.py +++ b/src/merge/resources/crm/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.issues.list() + client.crm.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.crm.issues.list() + await client.crm.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/leads/client.py b/src/merge/resources/crm/resources/leads/client.py index ba711e50..793ea73b 100644 --- a/src/merge/resources/crm/resources/leads/client.py +++ b/src/merge/resources/crm/resources/leads/client.py @@ -128,7 +128,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.leads.list() + client.crm.leads.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( converted_account_id=converted_account_id, @@ -343,7 +345,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.leads.remote_field_classes_list() + client.crm.leads.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -473,7 +477,9 @@ async def list( async def main() -> None: - await client.crm.leads.list() + await client.crm.leads.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -720,7 +726,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.leads.remote_field_classes_list() + await client.crm.leads.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/linked_accounts/client.py b/src/merge/resources/crm/resources/linked_accounts/client.py index 479471b9..80b19ced 100644 --- a/src/merge/resources/crm/resources/linked_accounts/client.py +++ b/src/merge/resources/crm/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.linked_accounts.list() + client.crm.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.crm.linked_accounts.list() + await client.crm.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/notes/client.py b/src/merge/resources/crm/resources/notes/client.py index 5ed1e428..f7fbd530 100644 --- a/src/merge/resources/crm/resources/notes/client.py +++ b/src/merge/resources/crm/resources/notes/client.py @@ -124,7 +124,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.notes.list() + client.crm.notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -338,7 +340,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.notes.remote_field_classes_list() + client.crm.notes.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -464,7 +468,9 @@ async def list( async def main() -> None: - await client.crm.notes.list() + await client.crm.notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -710,7 +716,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.notes.remote_field_classes_list() + await client.crm.notes.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/opportunities/client.py b/src/merge/resources/crm/resources/opportunities/client.py index c11ecf96..9e0e15e0 100644 --- a/src/merge/resources/crm/resources/opportunities/client.py +++ b/src/merge/resources/crm/resources/opportunities/client.py @@ -142,7 +142,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.opportunities.list() + client.crm.opportunities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -451,7 +453,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.opportunities.remote_field_classes_list() + client.crm.opportunities.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -593,7 +597,9 @@ async def list( async def main() -> None: - await client.crm.opportunities.list() + await client.crm.opportunities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -952,7 +958,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.opportunities.remote_field_classes_list() + await client.crm.opportunities.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/stages/client.py b/src/merge/resources/crm/resources/stages/client.py index fd69a8ba..efe35689 100644 --- a/src/merge/resources/crm/resources/stages/client.py +++ b/src/merge/resources/crm/resources/stages/client.py @@ -96,7 +96,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.stages.list() + client.crm.stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -226,7 +228,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.stages.remote_field_classes_list() + client.crm.stages.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -332,7 +336,9 @@ async def list( async def main() -> None: - await client.crm.stages.list() + await client.crm.stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -478,7 +484,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.stages.remote_field_classes_list() + await client.crm.stages.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/sync_status/client.py b/src/merge/resources/crm/resources/sync_status/client.py index 8f210d28..9a72c5cc 100644 --- a/src/merge/resources/crm/resources/sync_status/client.py +++ b/src/merge/resources/crm/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.sync_status.list() + client.crm.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.crm.sync_status.list() + await client.crm.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/tasks/client.py b/src/merge/resources/crm/resources/tasks/client.py index 4e61ae97..15a16cee 100644 --- a/src/merge/resources/crm/resources/tasks/client.py +++ b/src/merge/resources/crm/resources/tasks/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.tasks.list() + client.crm.tasks.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -401,7 +403,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.tasks.remote_field_classes_list() + client.crm.tasks.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -511,7 +515,9 @@ async def list( async def main() -> None: - await client.crm.tasks.list() + await client.crm.tasks.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -853,7 +859,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.tasks.remote_field_classes_list() + await client.crm.tasks.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/resources/users/client.py b/src/merge/resources/crm/resources/users/client.py index 1fd91cdb..d5671794 100644 --- a/src/merge/resources/crm/resources/users/client.py +++ b/src/merge/resources/crm/resources/users/client.py @@ -104,7 +104,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.users.list() + client.crm.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -277,7 +279,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.crm.users.remote_field_classes_list() + client.crm.users.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -387,7 +391,9 @@ async def list( async def main() -> None: - await client.crm.users.list() + await client.crm.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -584,7 +590,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.crm.users.remote_field_classes_list() + await client.crm.users.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/crm/types/remote_field_class.py b/src/merge/resources/crm/types/remote_field_class.py index 033ea3b6..76189afe 100644 --- a/src/merge/resources/crm/types/remote_field_class.py +++ b/src/merge/resources/crm/types/remote_field_class.py @@ -17,6 +17,7 @@ class RemoteFieldClass(UncheckedBaseModel): remote_key_name: typing.Optional[str] = None description: typing.Optional[str] = None is_custom: typing.Optional[bool] = None + is_common_model_field: typing.Optional[bool] = None is_required: typing.Optional[bool] = None field_type: typing.Optional[RemoteFieldClassFieldType] = None field_format: typing.Optional[RemoteFieldClassFieldFormat] = None diff --git a/src/merge/resources/filestorage/__init__.py b/src/merge/resources/filestorage/__init__.py index bd04cb02..f7f48bdc 100644 --- a/src/merge/resources/filestorage/__init__.py +++ b/src/merge/resources/filestorage/__init__.py @@ -5,7 +5,9 @@ from .types import ( AccountDetails, AccountDetailsAndActions, + AccountDetailsAndActionsCategory, AccountDetailsAndActionsIntegration, + AccountDetailsAndActionsStatus, AccountDetailsAndActionsStatusEnum, AccountIntegration, AccountToken, @@ -113,6 +115,7 @@ StatusFd5Enum, SyncStatus, SyncStatusLastSyncResult, + SyncStatusStatus, TypeEnum, User, ValidationProblemSource, @@ -121,6 +124,7 @@ ) from .resources import ( AsyncPassthroughRetrieveResponse, + EndUserDetailsRequestLanguage, FilesDownloadRequestMetaListRequestOrderBy, FilesListRequestExpand, FilesListRequestOrderBy, @@ -156,7 +160,9 @@ __all__ = [ "AccountDetails", "AccountDetailsAndActions", + "AccountDetailsAndActionsCategory", "AccountDetailsAndActionsIntegration", + "AccountDetailsAndActionsStatus", "AccountDetailsAndActionsStatusEnum", "AccountIntegration", "AccountToken", @@ -178,6 +184,7 @@ "Drive", "EnabledActionsEnum", "EncodingEnum", + "EndUserDetailsRequestLanguage", "ErrorValidationProblem", "EventTypeEnum", "ExternalTargetFieldApi", @@ -273,6 +280,7 @@ "StatusFd5Enum", "SyncStatus", "SyncStatusLastSyncResult", + "SyncStatusStatus", "TypeEnum", "User", "ValidationProblemSource", diff --git a/src/merge/resources/filestorage/resources/__init__.py b/src/merge/resources/filestorage/resources/__init__.py index 37439505..5afb8340 100644 --- a/src/merge/resources/filestorage/resources/__init__.py +++ b/src/merge/resources/filestorage/resources/__init__.py @@ -35,10 +35,12 @@ ) from .folders import FoldersListRequestExpand, FoldersRetrieveRequestExpand from .issues import IssuesListRequestStatus +from .link_token import EndUserDetailsRequestLanguage from .linked_accounts import LinkedAccountsListRequestCategory __all__ = [ "AsyncPassthroughRetrieveResponse", + "EndUserDetailsRequestLanguage", "FilesDownloadRequestMetaListRequestOrderBy", "FilesListRequestExpand", "FilesListRequestOrderBy", diff --git a/src/merge/resources/filestorage/resources/audit_trail/client.py b/src/merge/resources/filestorage/resources/audit_trail/client.py index aef09b3e..05d30b6f 100644 --- a/src/merge/resources/filestorage/resources/audit_trail/client.py +++ b/src/merge/resources/filestorage/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.audit_trail.list() + client.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.filestorage.audit_trail.list() + await client.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/drives/client.py b/src/merge/resources/filestorage/resources/drives/client.py index 580b2c96..655ed370 100644 --- a/src/merge/resources/filestorage/resources/drives/client.py +++ b/src/merge/resources/filestorage/resources/drives/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.drives.list() + client.filestorage.drives.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -253,7 +255,9 @@ async def list( async def main() -> None: - await client.filestorage.drives.list() + await client.filestorage.drives.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/files/client.py b/src/merge/resources/filestorage/resources/files/client.py index b18ef7d9..5910bfb6 100644 --- a/src/merge/resources/filestorage/resources/files/client.py +++ b/src/merge/resources/filestorage/resources/files/client.py @@ -127,7 +127,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.files.list() + client.filestorage.files.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -389,7 +391,9 @@ def download_request_meta_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.files.download_request_meta_list() + client.filestorage.files.download_request_meta_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.download_request_meta_list( created_after=created_after, @@ -543,7 +547,9 @@ async def list( async def main() -> None: - await client.filestorage.files.list() + await client.filestorage.files.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -838,7 +844,9 @@ async def download_request_meta_list( async def main() -> None: - await client.filestorage.files.download_request_meta_list() + await client.filestorage.files.download_request_meta_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/folders/client.py b/src/merge/resources/filestorage/resources/folders/client.py index c2a45b1f..85276beb 100644 --- a/src/merge/resources/filestorage/resources/folders/client.py +++ b/src/merge/resources/filestorage/resources/folders/client.py @@ -115,7 +115,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.folders.list() + client.filestorage.folders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -367,7 +369,9 @@ async def list( async def main() -> None: - await client.filestorage.folders.list() + await client.filestorage.folders.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/groups/client.py b/src/merge/resources/filestorage/resources/groups/client.py index 5e112f27..9db5bbc6 100644 --- a/src/merge/resources/filestorage/resources/groups/client.py +++ b/src/merge/resources/filestorage/resources/groups/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.groups.list() + client.filestorage.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -258,7 +260,9 @@ async def list( async def main() -> None: - await client.filestorage.groups.list() + await client.filestorage.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/issues/client.py b/src/merge/resources/filestorage/resources/issues/client.py index c99f2054..888a1f8e 100644 --- a/src/merge/resources/filestorage/resources/issues/client.py +++ b/src/merge/resources/filestorage/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.issues.list() + client.filestorage.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.filestorage.issues.list() + await client.filestorage.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/link_token/__init__.py b/src/merge/resources/filestorage/resources/link_token/__init__.py index 5cde0202..a640c12b 100644 --- a/src/merge/resources/filestorage/resources/link_token/__init__.py +++ b/src/merge/resources/filestorage/resources/link_token/__init__.py @@ -2,3 +2,6 @@ # isort: skip_file +from .types import EndUserDetailsRequestLanguage + +__all__ = ["EndUserDetailsRequestLanguage"] diff --git a/src/merge/resources/filestorage/resources/link_token/client.py b/src/merge/resources/filestorage/resources/link_token/client.py index 9f8213f5..4fb84800 100644 --- a/src/merge/resources/filestorage/resources/link_token/client.py +++ b/src/merge/resources/filestorage/resources/link_token/client.py @@ -7,9 +7,9 @@ from ...types.categories_enum import CategoriesEnum from ...types.common_model_scopes_body_request import CommonModelScopesBodyRequest from ...types.individual_common_model_scope_deserializer_request import IndividualCommonModelScopeDeserializerRequest -from ...types.language_enum import LanguageEnum from ...types.link_token import LinkToken from .raw_client import AsyncRawLinkTokenClient, RawLinkTokenClient +from .types.end_user_details_request_language import EndUserDetailsRequestLanguage # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -45,7 +45,7 @@ def create( category_common_model_scopes: typing.Optional[ typing.Dict[str, typing.Optional[typing.Sequence[IndividualCommonModelScopeDeserializerRequest]]] ] = OMIT, - language: typing.Optional[LanguageEnum] = OMIT, + language: typing.Optional[EndUserDetailsRequestLanguage] = OMIT, are_syncs_disabled: typing.Optional[bool] = OMIT, integration_specific_config: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT, request_options: typing.Optional[RequestOptions] = None, @@ -85,7 +85,7 @@ def create( category_common_model_scopes : typing.Optional[typing.Dict[str, typing.Optional[typing.Sequence[IndividualCommonModelScopeDeserializerRequest]]]] When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. - language : typing.Optional[LanguageEnum] + language : typing.Optional[EndUserDetailsRequestLanguage] The following subset of IETF language tags can be used to configure localization. * `en` - en @@ -170,7 +170,7 @@ async def create( category_common_model_scopes: typing.Optional[ typing.Dict[str, typing.Optional[typing.Sequence[IndividualCommonModelScopeDeserializerRequest]]] ] = OMIT, - language: typing.Optional[LanguageEnum] = OMIT, + language: typing.Optional[EndUserDetailsRequestLanguage] = OMIT, are_syncs_disabled: typing.Optional[bool] = OMIT, integration_specific_config: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT, request_options: typing.Optional[RequestOptions] = None, @@ -210,7 +210,7 @@ async def create( category_common_model_scopes : typing.Optional[typing.Dict[str, typing.Optional[typing.Sequence[IndividualCommonModelScopeDeserializerRequest]]]] When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. - language : typing.Optional[LanguageEnum] + language : typing.Optional[EndUserDetailsRequestLanguage] The following subset of IETF language tags can be used to configure localization. * `en` - en diff --git a/src/merge/resources/filestorage/resources/link_token/raw_client.py b/src/merge/resources/filestorage/resources/link_token/raw_client.py index 391c7bb5..ddb681cb 100644 --- a/src/merge/resources/filestorage/resources/link_token/raw_client.py +++ b/src/merge/resources/filestorage/resources/link_token/raw_client.py @@ -11,8 +11,8 @@ from ...types.categories_enum import CategoriesEnum from ...types.common_model_scopes_body_request import CommonModelScopesBodyRequest from ...types.individual_common_model_scope_deserializer_request import IndividualCommonModelScopeDeserializerRequest -from ...types.language_enum import LanguageEnum from ...types.link_token import LinkToken +from .types.end_user_details_request_language import EndUserDetailsRequestLanguage # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -37,7 +37,7 @@ def create( category_common_model_scopes: typing.Optional[ typing.Dict[str, typing.Optional[typing.Sequence[IndividualCommonModelScopeDeserializerRequest]]] ] = OMIT, - language: typing.Optional[LanguageEnum] = OMIT, + language: typing.Optional[EndUserDetailsRequestLanguage] = OMIT, are_syncs_disabled: typing.Optional[bool] = OMIT, integration_specific_config: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT, request_options: typing.Optional[RequestOptions] = None, @@ -77,7 +77,7 @@ def create( category_common_model_scopes : typing.Optional[typing.Dict[str, typing.Optional[typing.Sequence[IndividualCommonModelScopeDeserializerRequest]]]] When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. - language : typing.Optional[LanguageEnum] + language : typing.Optional[EndUserDetailsRequestLanguage] The following subset of IETF language tags can be used to configure localization. * `en` - en @@ -156,7 +156,7 @@ async def create( category_common_model_scopes: typing.Optional[ typing.Dict[str, typing.Optional[typing.Sequence[IndividualCommonModelScopeDeserializerRequest]]] ] = OMIT, - language: typing.Optional[LanguageEnum] = OMIT, + language: typing.Optional[EndUserDetailsRequestLanguage] = OMIT, are_syncs_disabled: typing.Optional[bool] = OMIT, integration_specific_config: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT, request_options: typing.Optional[RequestOptions] = None, @@ -196,7 +196,7 @@ async def create( category_common_model_scopes : typing.Optional[typing.Dict[str, typing.Optional[typing.Sequence[IndividualCommonModelScopeDeserializerRequest]]]] When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. - language : typing.Optional[LanguageEnum] + language : typing.Optional[EndUserDetailsRequestLanguage] The following subset of IETF language tags can be used to configure localization. * `en` - en diff --git a/src/merge/resources/filestorage/resources/link_token/types/__init__.py b/src/merge/resources/filestorage/resources/link_token/types/__init__.py new file mode 100644 index 00000000..fa266f8e --- /dev/null +++ b/src/merge/resources/filestorage/resources/link_token/types/__init__.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +# isort: skip_file + +from .end_user_details_request_language import EndUserDetailsRequestLanguage + +__all__ = ["EndUserDetailsRequestLanguage"] diff --git a/src/merge/resources/filestorage/resources/link_token/types/end_user_details_request_language.py b/src/merge/resources/filestorage/resources/link_token/types/end_user_details_request_language.py new file mode 100644 index 00000000..65c4b44a --- /dev/null +++ b/src/merge/resources/filestorage/resources/link_token/types/end_user_details_request_language.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from ....types.language_enum import LanguageEnum + +EndUserDetailsRequestLanguage = typing.Union[LanguageEnum, str] diff --git a/src/merge/resources/filestorage/resources/linked_accounts/client.py b/src/merge/resources/filestorage/resources/linked_accounts/client.py index fc7fe947..8ab62895 100644 --- a/src/merge/resources/filestorage/resources/linked_accounts/client.py +++ b/src/merge/resources/filestorage/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.linked_accounts.list() + client.filestorage.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.filestorage.linked_accounts.list() + await client.filestorage.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/sync_status/client.py b/src/merge/resources/filestorage/resources/sync_status/client.py index 34d83f4d..4611a846 100644 --- a/src/merge/resources/filestorage/resources/sync_status/client.py +++ b/src/merge/resources/filestorage/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.sync_status.list() + client.filestorage.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.filestorage.sync_status.list() + await client.filestorage.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/resources/users/client.py b/src/merge/resources/filestorage/resources/users/client.py index 4616da59..dc0d037e 100644 --- a/src/merge/resources/filestorage/resources/users/client.py +++ b/src/merge/resources/filestorage/resources/users/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.filestorage.users.list() + client.filestorage.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -253,7 +255,9 @@ async def list( async def main() -> None: - await client.filestorage.users.list() + await client.filestorage.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/filestorage/types/__init__.py b/src/merge/resources/filestorage/types/__init__.py index 5a8c33fd..bb5dede1 100644 --- a/src/merge/resources/filestorage/types/__init__.py +++ b/src/merge/resources/filestorage/types/__init__.py @@ -4,7 +4,9 @@ from .account_details import AccountDetails from .account_details_and_actions import AccountDetailsAndActions +from .account_details_and_actions_category import AccountDetailsAndActionsCategory from .account_details_and_actions_integration import AccountDetailsAndActionsIntegration +from .account_details_and_actions_status import AccountDetailsAndActionsStatus from .account_details_and_actions_status_enum import AccountDetailsAndActionsStatusEnum from .account_integration import AccountIntegration from .account_token import AccountToken @@ -114,6 +116,7 @@ from .status_fd_5_enum import StatusFd5Enum from .sync_status import SyncStatus from .sync_status_last_sync_result import SyncStatusLastSyncResult +from .sync_status_status import SyncStatusStatus from .type_enum import TypeEnum from .user import User from .validation_problem_source import ValidationProblemSource @@ -123,7 +126,9 @@ __all__ = [ "AccountDetails", "AccountDetailsAndActions", + "AccountDetailsAndActionsCategory", "AccountDetailsAndActionsIntegration", + "AccountDetailsAndActionsStatus", "AccountDetailsAndActionsStatusEnum", "AccountIntegration", "AccountToken", @@ -231,6 +236,7 @@ "StatusFd5Enum", "SyncStatus", "SyncStatusLastSyncResult", + "SyncStatusStatus", "TypeEnum", "User", "ValidationProblemSource", diff --git a/src/merge/resources/filestorage/types/account_details_and_actions.py b/src/merge/resources/filestorage/types/account_details_and_actions.py index 897c08ba..93c874ed 100644 --- a/src/merge/resources/filestorage/types/account_details_and_actions.py +++ b/src/merge/resources/filestorage/types/account_details_and_actions.py @@ -6,9 +6,9 @@ import pydantic from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel +from .account_details_and_actions_category import AccountDetailsAndActionsCategory from .account_details_and_actions_integration import AccountDetailsAndActionsIntegration -from .account_details_and_actions_status_enum import AccountDetailsAndActionsStatusEnum -from .category_enum import CategoryEnum +from .account_details_and_actions_status import AccountDetailsAndActionsStatus class AccountDetailsAndActions(UncheckedBaseModel): @@ -22,8 +22,8 @@ class AccountDetailsAndActions(UncheckedBaseModel): """ id: str - category: typing.Optional[CategoryEnum] = None - status: AccountDetailsAndActionsStatusEnum + category: typing.Optional[AccountDetailsAndActionsCategory] = None + status: AccountDetailsAndActionsStatus status_detail: typing.Optional[str] = None end_user_origin_id: typing.Optional[str] = None end_user_organization_name: str diff --git a/src/merge/resources/filestorage/types/account_details_and_actions_category.py b/src/merge/resources/filestorage/types/account_details_and_actions_category.py new file mode 100644 index 00000000..93b4188b --- /dev/null +++ b/src/merge/resources/filestorage/types/account_details_and_actions_category.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .category_enum import CategoryEnum + +AccountDetailsAndActionsCategory = typing.Union[CategoryEnum, str] diff --git a/src/merge/resources/filestorage/types/account_details_and_actions_status.py b/src/merge/resources/filestorage/types/account_details_and_actions_status.py new file mode 100644 index 00000000..445922f8 --- /dev/null +++ b/src/merge/resources/filestorage/types/account_details_and_actions_status.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .account_details_and_actions_status_enum import AccountDetailsAndActionsStatusEnum + +AccountDetailsAndActionsStatus = typing.Union[AccountDetailsAndActionsStatusEnum, str] diff --git a/src/merge/resources/filestorage/types/sync_status.py b/src/merge/resources/filestorage/types/sync_status.py index 4a628c4f..07ab1dc2 100644 --- a/src/merge/resources/filestorage/types/sync_status.py +++ b/src/merge/resources/filestorage/types/sync_status.py @@ -7,8 +7,8 @@ from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel from .selective_sync_configurations_usage_enum import SelectiveSyncConfigurationsUsageEnum -from .status_fd_5_enum import StatusFd5Enum from .sync_status_last_sync_result import SyncStatusLastSyncResult +from .sync_status_status import SyncStatusStatus class SyncStatus(UncheckedBaseModel): @@ -27,7 +27,7 @@ class SyncStatus(UncheckedBaseModel): next_sync_start: typing.Optional[dt.datetime] = None last_sync_result: typing.Optional[SyncStatusLastSyncResult] = None last_sync_finished: typing.Optional[dt.datetime] = None - status: StatusFd5Enum + status: SyncStatusStatus is_initial_sync: bool selective_sync_configurations_usage: typing.Optional[SelectiveSyncConfigurationsUsageEnum] = None diff --git a/src/merge/resources/filestorage/types/sync_status_status.py b/src/merge/resources/filestorage/types/sync_status_status.py new file mode 100644 index 00000000..78e4cc47 --- /dev/null +++ b/src/merge/resources/filestorage/types/sync_status_status.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .status_fd_5_enum import StatusFd5Enum + +SyncStatusStatus = typing.Union[StatusFd5Enum, str] diff --git a/src/merge/resources/hris/__init__.py b/src/merge/resources/hris/__init__.py index adaa795d..e1abb7db 100644 --- a/src/merge/resources/hris/__init__.py +++ b/src/merge/resources/hris/__init__.py @@ -7,6 +7,7 @@ AccountDetailsAndActions, AccountDetailsAndActionsCategory, AccountDetailsAndActionsIntegration, + AccountDetailsAndActionsStatus, AccountDetailsAndActionsStatusEnum, AccountDetailsCategory, AccountIntegration, @@ -171,6 +172,7 @@ StatusFd5Enum, SyncStatus, SyncStatusLastSyncResult, + SyncStatusStatus, Tax, Team, TeamParentTeam, @@ -285,6 +287,7 @@ "AccountDetailsAndActions", "AccountDetailsAndActionsCategory", "AccountDetailsAndActionsIntegration", + "AccountDetailsAndActionsStatus", "AccountDetailsAndActionsStatusEnum", "AccountDetailsCategory", "AccountIntegration", @@ -482,6 +485,7 @@ "StatusFd5Enum", "SyncStatus", "SyncStatusLastSyncResult", + "SyncStatusStatus", "Tax", "Team", "TeamParentTeam", diff --git a/src/merge/resources/hris/resources/audit_trail/client.py b/src/merge/resources/hris/resources/audit_trail/client.py index 7f5d6791..4f8aa7d3 100644 --- a/src/merge/resources/hris/resources/audit_trail/client.py +++ b/src/merge/resources/hris/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.audit_trail.list() + client.hris.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.hris.audit_trail.list() + await client.hris.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/bank_info/client.py b/src/merge/resources/hris/resources/bank_info/client.py index baa4ff18..8923a387 100644 --- a/src/merge/resources/hris/resources/bank_info/client.py +++ b/src/merge/resources/hris/resources/bank_info/client.py @@ -124,7 +124,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.bank_info.list() + client.hris.bank_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_type=account_type, @@ -330,7 +332,9 @@ async def list( async def main() -> None: - await client.hris.bank_info.list() + await client.hris.bank_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/benefits/client.py b/src/merge/resources/hris/resources/benefits/client.py index 76ed436e..a6f19dad 100644 --- a/src/merge/resources/hris/resources/benefits/client.py +++ b/src/merge/resources/hris/resources/benefits/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.benefits.list() + client.hris.benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.hris.benefits.list() + await client.hris.benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/companies/client.py b/src/merge/resources/hris/resources/companies/client.py index 3c5355ea..5b756b5f 100644 --- a/src/merge/resources/hris/resources/companies/client.py +++ b/src/merge/resources/hris/resources/companies/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.companies.list() + client.hris.companies.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.hris.companies.list() + await client.hris.companies.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/dependents/client.py b/src/merge/resources/hris/resources/dependents/client.py index 7f2f7710..bfd225ff 100644 --- a/src/merge/resources/hris/resources/dependents/client.py +++ b/src/merge/resources/hris/resources/dependents/client.py @@ -95,7 +95,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.dependents.list() + client.hris.dependents.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -258,7 +260,9 @@ async def list( async def main() -> None: - await client.hris.dependents.list() + await client.hris.dependents.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/employee_payroll_runs/client.py b/src/merge/resources/hris/resources/employee_payroll_runs/client.py index 93dd56df..0ab87bf7 100644 --- a/src/merge/resources/hris/resources/employee_payroll_runs/client.py +++ b/src/merge/resources/hris/resources/employee_payroll_runs/client.py @@ -121,7 +121,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.employee_payroll_runs.list() + client.hris.employee_payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -314,7 +316,9 @@ async def list( async def main() -> None: - await client.hris.employee_payroll_runs.list() + await client.hris.employee_payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/employees/client.py b/src/merge/resources/hris/resources/employees/client.py index 7c0498de..f1f60ae1 100644 --- a/src/merge/resources/hris/resources/employees/client.py +++ b/src/merge/resources/hris/resources/employees/client.py @@ -201,7 +201,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.employees.list() + client.hris.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( company_id=company_id, @@ -612,7 +614,9 @@ async def list( async def main() -> None: - await client.hris.employees.list() + await client.hris.employees.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/employer_benefits/client.py b/src/merge/resources/hris/resources/employer_benefits/client.py index 3201e062..11737216 100644 --- a/src/merge/resources/hris/resources/employer_benefits/client.py +++ b/src/merge/resources/hris/resources/employer_benefits/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.employer_benefits.list() + client.hris.employer_benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.hris.employer_benefits.list() + await client.hris.employer_benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/employments/client.py b/src/merge/resources/hris/resources/employments/client.py index 22371621..581e1875 100644 --- a/src/merge/resources/hris/resources/employments/client.py +++ b/src/merge/resources/hris/resources/employments/client.py @@ -118,7 +118,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.employments.list() + client.hris.employments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -311,7 +313,9 @@ async def list( async def main() -> None: - await client.hris.employments.list() + await client.hris.employments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/groups/client.py b/src/merge/resources/hris/resources/groups/client.py index 454392ad..60d862f2 100644 --- a/src/merge/resources/hris/resources/groups/client.py +++ b/src/merge/resources/hris/resources/groups/client.py @@ -111,7 +111,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.groups.list() + client.hris.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -299,7 +301,9 @@ async def list( async def main() -> None: - await client.hris.groups.list() + await client.hris.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/issues/client.py b/src/merge/resources/hris/resources/issues/client.py index 3839055e..02a8ddc3 100644 --- a/src/merge/resources/hris/resources/issues/client.py +++ b/src/merge/resources/hris/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.issues.list() + client.hris.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.hris.issues.list() + await client.hris.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/linked_accounts/client.py b/src/merge/resources/hris/resources/linked_accounts/client.py index fb325a41..464827a7 100644 --- a/src/merge/resources/hris/resources/linked_accounts/client.py +++ b/src/merge/resources/hris/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.linked_accounts.list() + client.hris.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.hris.linked_accounts.list() + await client.hris.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/locations/client.py b/src/merge/resources/hris/resources/locations/client.py index b8b18833..12fa7031 100644 --- a/src/merge/resources/hris/resources/locations/client.py +++ b/src/merge/resources/hris/resources/locations/client.py @@ -111,7 +111,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.locations.list() + client.hris.locations.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -292,7 +294,9 @@ async def list( async def main() -> None: - await client.hris.locations.list() + await client.hris.locations.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/pay_groups/client.py b/src/merge/resources/hris/resources/pay_groups/client.py index be59663a..abccf33a 100644 --- a/src/merge/resources/hris/resources/pay_groups/client.py +++ b/src/merge/resources/hris/resources/pay_groups/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.pay_groups.list() + client.hris.pay_groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.hris.pay_groups.list() + await client.hris.pay_groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/payroll_runs/client.py b/src/merge/resources/hris/resources/payroll_runs/client.py index 9de9d3c2..5638f7df 100644 --- a/src/merge/resources/hris/resources/payroll_runs/client.py +++ b/src/merge/resources/hris/resources/payroll_runs/client.py @@ -130,7 +130,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.payroll_runs.list() + client.hris.payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -334,7 +336,9 @@ async def list( async def main() -> None: - await client.hris.payroll_runs.list() + await client.hris.payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/sync_status/client.py b/src/merge/resources/hris/resources/sync_status/client.py index fb1b6a50..aa845f9e 100644 --- a/src/merge/resources/hris/resources/sync_status/client.py +++ b/src/merge/resources/hris/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.sync_status.list() + client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.hris.sync_status.list() + await client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/teams/client.py b/src/merge/resources/hris/resources/teams/client.py index f0ba24da..f17a9a47 100644 --- a/src/merge/resources/hris/resources/teams/client.py +++ b/src/merge/resources/hris/resources/teams/client.py @@ -99,7 +99,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.teams.list() + client.hris.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -267,7 +269,9 @@ async def list( async def main() -> None: - await client.hris.teams.list() + await client.hris.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/time_off/client.py b/src/merge/resources/hris/resources/time_off/client.py index ff2cbfb7..5d3d3239 100644 --- a/src/merge/resources/hris/resources/time_off/client.py +++ b/src/merge/resources/hris/resources/time_off/client.py @@ -162,7 +162,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.time_off.list() + client.hris.time_off.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( approver_id=approver_id, @@ -472,7 +474,9 @@ async def list( async def main() -> None: - await client.hris.time_off.list() + await client.hris.time_off.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/time_off_balances/client.py b/src/merge/resources/hris/resources/time_off_balances/client.py index 9b32ead7..6f272e00 100644 --- a/src/merge/resources/hris/resources/time_off_balances/client.py +++ b/src/merge/resources/hris/resources/time_off_balances/client.py @@ -119,7 +119,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.time_off_balances.list() + client.hris.time_off_balances.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -319,7 +321,9 @@ async def list( async def main() -> None: - await client.hris.time_off_balances.list() + await client.hris.time_off_balances.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/resources/timesheet_entries/client.py b/src/merge/resources/hris/resources/timesheet_entries/client.py index 5162fa48..5689a64a 100644 --- a/src/merge/resources/hris/resources/timesheet_entries/client.py +++ b/src/merge/resources/hris/resources/timesheet_entries/client.py @@ -126,7 +126,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.hris.timesheet_entries.list() + client.hris.timesheet_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -393,7 +395,9 @@ async def list( async def main() -> None: - await client.hris.timesheet_entries.list() + await client.hris.timesheet_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/hris/types/__init__.py b/src/merge/resources/hris/types/__init__.py index 43825e60..6fa54b58 100644 --- a/src/merge/resources/hris/types/__init__.py +++ b/src/merge/resources/hris/types/__init__.py @@ -6,6 +6,7 @@ from .account_details_and_actions import AccountDetailsAndActions from .account_details_and_actions_category import AccountDetailsAndActionsCategory from .account_details_and_actions_integration import AccountDetailsAndActionsIntegration +from .account_details_and_actions_status import AccountDetailsAndActionsStatus from .account_details_and_actions_status_enum import AccountDetailsAndActionsStatusEnum from .account_details_category import AccountDetailsCategory from .account_integration import AccountIntegration @@ -172,6 +173,7 @@ from .status_fd_5_enum import StatusFd5Enum from .sync_status import SyncStatus from .sync_status_last_sync_result import SyncStatusLastSyncResult +from .sync_status_status import SyncStatusStatus from .tax import Tax from .team import Team from .team_parent_team import TeamParentTeam @@ -207,6 +209,7 @@ "AccountDetailsAndActions", "AccountDetailsAndActionsCategory", "AccountDetailsAndActionsIntegration", + "AccountDetailsAndActionsStatus", "AccountDetailsAndActionsStatusEnum", "AccountDetailsCategory", "AccountIntegration", @@ -371,6 +374,7 @@ "StatusFd5Enum", "SyncStatus", "SyncStatusLastSyncResult", + "SyncStatusStatus", "Tax", "Team", "TeamParentTeam", diff --git a/src/merge/resources/hris/types/account_details_and_actions.py b/src/merge/resources/hris/types/account_details_and_actions.py index 551a4fa5..93c874ed 100644 --- a/src/merge/resources/hris/types/account_details_and_actions.py +++ b/src/merge/resources/hris/types/account_details_and_actions.py @@ -8,7 +8,7 @@ from ....core.unchecked_base_model import UncheckedBaseModel from .account_details_and_actions_category import AccountDetailsAndActionsCategory from .account_details_and_actions_integration import AccountDetailsAndActionsIntegration -from .account_details_and_actions_status_enum import AccountDetailsAndActionsStatusEnum +from .account_details_and_actions_status import AccountDetailsAndActionsStatus class AccountDetailsAndActions(UncheckedBaseModel): @@ -23,7 +23,7 @@ class AccountDetailsAndActions(UncheckedBaseModel): id: str category: typing.Optional[AccountDetailsAndActionsCategory] = None - status: AccountDetailsAndActionsStatusEnum + status: AccountDetailsAndActionsStatus status_detail: typing.Optional[str] = None end_user_origin_id: typing.Optional[str] = None end_user_organization_name: str diff --git a/src/merge/resources/hris/types/account_details_and_actions_status.py b/src/merge/resources/hris/types/account_details_and_actions_status.py new file mode 100644 index 00000000..445922f8 --- /dev/null +++ b/src/merge/resources/hris/types/account_details_and_actions_status.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .account_details_and_actions_status_enum import AccountDetailsAndActionsStatusEnum + +AccountDetailsAndActionsStatus = typing.Union[AccountDetailsAndActionsStatusEnum, str] diff --git a/src/merge/resources/hris/types/benefit.py b/src/merge/resources/hris/types/benefit.py index fb4a9388..3ceeb1bc 100644 --- a/src/merge/resources/hris/types/benefit.py +++ b/src/merge/resources/hris/types/benefit.py @@ -73,14 +73,14 @@ class Benefit(UncheckedBaseModel): The day and time the benefit ended. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None) + employer_benefit: typing.Optional[str] = pydantic.Field(default=None) """ - Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + The employer benefit plan the employee is enrolled in. """ - employer_benefit: typing.Optional[str] = pydantic.Field(default=None) + remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None) """ - The employer benefit plan the employee is enrolled in. + Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). """ field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None diff --git a/src/merge/resources/hris/types/sync_status.py b/src/merge/resources/hris/types/sync_status.py index 4a628c4f..07ab1dc2 100644 --- a/src/merge/resources/hris/types/sync_status.py +++ b/src/merge/resources/hris/types/sync_status.py @@ -7,8 +7,8 @@ from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel from .selective_sync_configurations_usage_enum import SelectiveSyncConfigurationsUsageEnum -from .status_fd_5_enum import StatusFd5Enum from .sync_status_last_sync_result import SyncStatusLastSyncResult +from .sync_status_status import SyncStatusStatus class SyncStatus(UncheckedBaseModel): @@ -27,7 +27,7 @@ class SyncStatus(UncheckedBaseModel): next_sync_start: typing.Optional[dt.datetime] = None last_sync_result: typing.Optional[SyncStatusLastSyncResult] = None last_sync_finished: typing.Optional[dt.datetime] = None - status: StatusFd5Enum + status: SyncStatusStatus is_initial_sync: bool selective_sync_configurations_usage: typing.Optional[SelectiveSyncConfigurationsUsageEnum] = None diff --git a/src/merge/resources/hris/types/sync_status_status.py b/src/merge/resources/hris/types/sync_status_status.py new file mode 100644 index 00000000..78e4cc47 --- /dev/null +++ b/src/merge/resources/hris/types/sync_status_status.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .status_fd_5_enum import StatusFd5Enum + +SyncStatusStatus = typing.Union[StatusFd5Enum, str] diff --git a/src/merge/resources/ticketing/__init__.py b/src/merge/resources/ticketing/__init__.py index 7264e48f..e2595b11 100644 --- a/src/merge/resources/ticketing/__init__.py +++ b/src/merge/resources/ticketing/__init__.py @@ -132,6 +132,7 @@ StatusFd5Enum, SyncStatus, SyncStatusLastSyncResult, + SyncStatusStatus, Tag, Team, Ticket, @@ -362,6 +363,7 @@ "StatusFd5Enum", "SyncStatus", "SyncStatusLastSyncResult", + "SyncStatusStatus", "Tag", "Team", "Ticket", diff --git a/src/merge/resources/ticketing/resources/accounts/client.py b/src/merge/resources/ticketing/resources/accounts/client.py index 1ecd7ee2..0eb93e75 100644 --- a/src/merge/resources/ticketing/resources/accounts/client.py +++ b/src/merge/resources/ticketing/resources/accounts/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.accounts.list() + client.ticketing.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ticketing.accounts.list() + await client.ticketing.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/attachments/client.py b/src/merge/resources/ticketing/resources/attachments/client.py index 8d8155a7..ff82e3cf 100644 --- a/src/merge/resources/ticketing/resources/attachments/client.py +++ b/src/merge/resources/ticketing/resources/attachments/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.attachments.list() + client.ticketing.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -390,7 +392,9 @@ async def list( async def main() -> None: - await client.ticketing.attachments.list() + await client.ticketing.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/audit_trail/client.py b/src/merge/resources/ticketing/resources/audit_trail/client.py index 59fe3392..40225482 100644 --- a/src/merge/resources/ticketing/resources/audit_trail/client.py +++ b/src/merge/resources/ticketing/resources/audit_trail/client.py @@ -73,7 +73,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.audit_trail.list() + client.ticketing.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( cursor=cursor, @@ -157,7 +159,9 @@ async def list( async def main() -> None: - await client.ticketing.audit_trail.list() + await client.ticketing.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/collections/client.py b/src/merge/resources/ticketing/resources/collections/client.py index 16675970..74184c4e 100644 --- a/src/merge/resources/ticketing/resources/collections/client.py +++ b/src/merge/resources/ticketing/resources/collections/client.py @@ -113,7 +113,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.collections.list() + client.ticketing.collections.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( collection_type=collection_type, @@ -190,6 +192,7 @@ def viewers_list( ) client.ticketing.collections.viewers_list( collection_id="collection_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.viewers_list( @@ -375,7 +378,9 @@ async def list( async def main() -> None: - await client.ticketing.collections.list() + await client.ticketing.collections.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -460,6 +465,7 @@ async def viewers_list( async def main() -> None: await client.ticketing.collections.viewers_list( collection_id="collection_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/ticketing/resources/comments/client.py b/src/merge/resources/ticketing/resources/comments/client.py index 06b7d2d6..179ad2a1 100644 --- a/src/merge/resources/ticketing/resources/comments/client.py +++ b/src/merge/resources/ticketing/resources/comments/client.py @@ -111,7 +111,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.comments.list() + client.ticketing.comments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -358,7 +360,9 @@ async def list( async def main() -> None: - await client.ticketing.comments.list() + await client.ticketing.comments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/contacts/client.py b/src/merge/resources/ticketing/resources/contacts/client.py index aa5fe595..d36d28fc 100644 --- a/src/merge/resources/ticketing/resources/contacts/client.py +++ b/src/merge/resources/ticketing/resources/contacts/client.py @@ -101,7 +101,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.contacts.list() + client.ticketing.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -338,7 +340,9 @@ async def list( async def main() -> None: - await client.ticketing.contacts.list() + await client.ticketing.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/issues/client.py b/src/merge/resources/ticketing/resources/issues/client.py index ea663780..24550de7 100644 --- a/src/merge/resources/ticketing/resources/issues/client.py +++ b/src/merge/resources/ticketing/resources/issues/client.py @@ -108,7 +108,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.issues.list() + client.ticketing.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_token=account_token, @@ -263,7 +265,9 @@ async def list( async def main() -> None: - await client.ticketing.issues.list() + await client.ticketing.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/linked_accounts/client.py b/src/merge/resources/ticketing/resources/linked_accounts/client.py index afaca7a3..31a9f3db 100644 --- a/src/merge/resources/ticketing/resources/linked_accounts/client.py +++ b/src/merge/resources/ticketing/resources/linked_accounts/client.py @@ -109,7 +109,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.linked_accounts.list() + client.ticketing.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( category=category, @@ -235,7 +237,9 @@ async def list( async def main() -> None: - await client.ticketing.linked_accounts.list() + await client.ticketing.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/projects/client.py b/src/merge/resources/ticketing/resources/projects/client.py index be9c4fb2..edb34c7f 100644 --- a/src/merge/resources/ticketing/resources/projects/client.py +++ b/src/merge/resources/ticketing/resources/projects/client.py @@ -93,7 +93,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.projects.list() + client.ticketing.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -214,6 +216,7 @@ def users_list( ) client.ticketing.projects.users_list( parent_id="parent_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.users_list( @@ -315,7 +318,9 @@ async def list( async def main() -> None: - await client.ticketing.projects.list() + await client.ticketing.projects.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -452,6 +457,7 @@ async def users_list( async def main() -> None: await client.ticketing.projects.users_list( parent_id="parent_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) diff --git a/src/merge/resources/ticketing/resources/roles/client.py b/src/merge/resources/ticketing/resources/roles/client.py index d026ac37..d4c63c42 100644 --- a/src/merge/resources/ticketing/resources/roles/client.py +++ b/src/merge/resources/ticketing/resources/roles/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.roles.list() + client.ticketing.roles.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ticketing.roles.list() + await client.ticketing.roles.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/sync_status/client.py b/src/merge/resources/ticketing/resources/sync_status/client.py index 91bbdd7e..4e7f6d88 100644 --- a/src/merge/resources/ticketing/resources/sync_status/client.py +++ b/src/merge/resources/ticketing/resources/sync_status/client.py @@ -57,7 +57,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.sync_status.list() + client.ticketing.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options) return _response.data @@ -117,7 +119,9 @@ async def list( async def main() -> None: - await client.ticketing.sync_status.list() + await client.ticketing.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/tags/client.py b/src/merge/resources/ticketing/resources/tags/client.py index 34dbb860..74abf54f 100644 --- a/src/merge/resources/ticketing/resources/tags/client.py +++ b/src/merge/resources/ticketing/resources/tags/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.tags.list() + client.ticketing.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ticketing.tags.list() + await client.ticketing.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/teams/client.py b/src/merge/resources/ticketing/resources/teams/client.py index 0bf2170e..625edb78 100644 --- a/src/merge/resources/ticketing/resources/teams/client.py +++ b/src/merge/resources/ticketing/resources/teams/client.py @@ -91,7 +91,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.teams.list() + client.ticketing.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -244,7 +246,9 @@ async def list( async def main() -> None: - await client.ticketing.teams.list() + await client.ticketing.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/tickets/client.py b/src/merge/resources/ticketing/resources/tickets/client.py index 6862ebf3..1d03e8e4 100644 --- a/src/merge/resources/ticketing/resources/tickets/client.py +++ b/src/merge/resources/ticketing/resources/tickets/client.py @@ -201,7 +201,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.tickets.list() + client.ticketing.tickets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( account_id=account_id, @@ -462,6 +464,7 @@ def viewers_list( ) client.ticketing.tickets.viewers_list( ticket_id="ticket_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) """ _response = self._raw_client.viewers_list( @@ -606,7 +609,9 @@ def remote_field_classes_list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.tickets.remote_field_classes_list() + client.ticketing.tickets.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.remote_field_classes_list( cursor=cursor, @@ -801,7 +806,9 @@ async def list( async def main() -> None: - await client.ticketing.tickets.list() + await client.ticketing.tickets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) @@ -1094,6 +1101,7 @@ async def viewers_list( async def main() -> None: await client.ticketing.tickets.viewers_list( ticket_id="ticket_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -1264,7 +1272,9 @@ async def remote_field_classes_list( async def main() -> None: - await client.ticketing.tickets.remote_field_classes_list() + await client.ticketing.tickets.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/resources/users/client.py b/src/merge/resources/ticketing/resources/users/client.py index 4acf3693..d770ab9e 100644 --- a/src/merge/resources/ticketing/resources/users/client.py +++ b/src/merge/resources/ticketing/resources/users/client.py @@ -105,7 +105,9 @@ def list( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) - client.ticketing.users.list() + client.ticketing.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) """ _response = self._raw_client.list( created_after=created_after, @@ -278,7 +280,9 @@ async def list( async def main() -> None: - await client.ticketing.users.list() + await client.ticketing.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ) asyncio.run(main()) diff --git a/src/merge/resources/ticketing/types/__init__.py b/src/merge/resources/ticketing/types/__init__.py index b40b4709..272465d0 100644 --- a/src/merge/resources/ticketing/types/__init__.py +++ b/src/merge/resources/ticketing/types/__init__.py @@ -133,6 +133,7 @@ from .status_fd_5_enum import StatusFd5Enum from .sync_status import SyncStatus from .sync_status_last_sync_result import SyncStatusLastSyncResult +from .sync_status_status import SyncStatusStatus from .tag import Tag from .team import Team from .ticket import Ticket @@ -306,6 +307,7 @@ "StatusFd5Enum", "SyncStatus", "SyncStatusLastSyncResult", + "SyncStatusStatus", "Tag", "Team", "Ticket", diff --git a/src/merge/resources/ticketing/types/patched_ticket_request.py b/src/merge/resources/ticketing/types/patched_ticket_request.py index 01f0d4a9..d31860df 100644 --- a/src/merge/resources/ticketing/types/patched_ticket_request.py +++ b/src/merge/resources/ticketing/types/patched_ticket_request.py @@ -98,11 +98,6 @@ class PatchedTicketRequest(UncheckedBaseModel): tags: typing.Optional[typing.List[typing.Optional[str]]] = None roles: typing.Optional[typing.List[typing.Optional[str]]] = None - completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) - """ - When the ticket was completed. - """ - ticket_url: typing.Optional[str] = pydantic.Field(default=None) """ The 3rd party url of the Ticket. @@ -118,6 +113,11 @@ class PatchedTicketRequest(UncheckedBaseModel): * `LOW` - LOW """ + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) + """ + When the ticket was completed. + """ + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None diff --git a/src/merge/resources/ticketing/types/remote_field_class.py b/src/merge/resources/ticketing/types/remote_field_class.py index 033ea3b6..76189afe 100644 --- a/src/merge/resources/ticketing/types/remote_field_class.py +++ b/src/merge/resources/ticketing/types/remote_field_class.py @@ -17,6 +17,7 @@ class RemoteFieldClass(UncheckedBaseModel): remote_key_name: typing.Optional[str] = None description: typing.Optional[str] = None is_custom: typing.Optional[bool] = None + is_common_model_field: typing.Optional[bool] = None is_required: typing.Optional[bool] = None field_type: typing.Optional[RemoteFieldClassFieldType] = None field_format: typing.Optional[RemoteFieldClassFieldFormat] = None diff --git a/src/merge/resources/ticketing/types/role_ticket_access.py b/src/merge/resources/ticketing/types/role_ticket_access.py index bf10da43..33e407ac 100644 --- a/src/merge/resources/ticketing/types/role_ticket_access.py +++ b/src/merge/resources/ticketing/types/role_ticket_access.py @@ -4,4 +4,4 @@ from .ticket_access_enum import TicketAccessEnum -RoleTicketAccess = typing.Union[str, TicketAccessEnum] +RoleTicketAccess = typing.Union[TicketAccessEnum, str] diff --git a/src/merge/resources/ticketing/types/sync_status.py b/src/merge/resources/ticketing/types/sync_status.py index 4a628c4f..07ab1dc2 100644 --- a/src/merge/resources/ticketing/types/sync_status.py +++ b/src/merge/resources/ticketing/types/sync_status.py @@ -7,8 +7,8 @@ from ....core.pydantic_utilities import IS_PYDANTIC_V2 from ....core.unchecked_base_model import UncheckedBaseModel from .selective_sync_configurations_usage_enum import SelectiveSyncConfigurationsUsageEnum -from .status_fd_5_enum import StatusFd5Enum from .sync_status_last_sync_result import SyncStatusLastSyncResult +from .sync_status_status import SyncStatusStatus class SyncStatus(UncheckedBaseModel): @@ -27,7 +27,7 @@ class SyncStatus(UncheckedBaseModel): next_sync_start: typing.Optional[dt.datetime] = None last_sync_result: typing.Optional[SyncStatusLastSyncResult] = None last_sync_finished: typing.Optional[dt.datetime] = None - status: StatusFd5Enum + status: SyncStatusStatus is_initial_sync: bool selective_sync_configurations_usage: typing.Optional[SelectiveSyncConfigurationsUsageEnum] = None diff --git a/src/merge/resources/ticketing/types/sync_status_status.py b/src/merge/resources/ticketing/types/sync_status_status.py new file mode 100644 index 00000000..78e4cc47 --- /dev/null +++ b/src/merge/resources/ticketing/types/sync_status_status.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .status_fd_5_enum import StatusFd5Enum + +SyncStatusStatus = typing.Union[StatusFd5Enum, str] diff --git a/src/merge/resources/ticketing/types/ticket.py b/src/merge/resources/ticketing/types/ticket.py index 0a550a82..6b7963ba 100644 --- a/src/merge/resources/ticketing/types/ticket.py +++ b/src/merge/resources/ticketing/types/ticket.py @@ -126,6 +126,21 @@ class Ticket(UncheckedBaseModel): tags: typing.Optional[typing.List[typing.Optional[str]]] = None roles: typing.Optional[typing.List[typing.Optional[str]]] = None + ticket_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The 3rd party url of the Ticket. + """ + + priority: typing.Optional[TicketPriority] = pydantic.Field(default=None) + """ + The priority or urgency of the Ticket. + + * `URGENT` - URGENT + * `HIGH` - HIGH + * `NORMAL` - NORMAL + * `LOW` - LOW + """ + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's ticket was created. @@ -146,21 +161,6 @@ class Ticket(UncheckedBaseModel): Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). """ - ticket_url: typing.Optional[str] = pydantic.Field(default=None) - """ - The 3rd party url of the Ticket. - """ - - priority: typing.Optional[TicketPriority] = pydantic.Field(default=None) - """ - The priority or urgency of the Ticket. - - * `URGENT` - URGENT - * `HIGH` - HIGH - * `NORMAL` - NORMAL - * `LOW` - LOW - """ - field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None remote_data: typing.Optional[typing.List[RemoteData]] = None remote_fields: typing.Optional[typing.List[RemoteField]] = None diff --git a/src/merge/resources/ticketing/types/ticket_request.py b/src/merge/resources/ticketing/types/ticket_request.py index ed0e1ec4..e7639ad2 100644 --- a/src/merge/resources/ticketing/types/ticket_request.py +++ b/src/merge/resources/ticketing/types/ticket_request.py @@ -113,11 +113,6 @@ class TicketRequest(UncheckedBaseModel): tags: typing.Optional[typing.List[typing.Optional[str]]] = None roles: typing.Optional[typing.List[typing.Optional[str]]] = None - completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) - """ - When the ticket was completed. - """ - ticket_url: typing.Optional[str] = pydantic.Field(default=None) """ The 3rd party url of the Ticket. @@ -133,6 +128,11 @@ class TicketRequest(UncheckedBaseModel): * `LOW` - LOW """ + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) + """ + When the ticket was completed. + """ + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None