{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Hyperline","colors":{"primary":"#1A1A1A","light":"#999999","dark":"#1A1A1A"},"logo":{"light":"https://mintcdn.com/hyperline/G-7ZQgHUOVHWwtUN/layout/logo-dark.png?fit=max\u0026auto=format\u0026n=G-7ZQgHUOVHWwtUN\u0026q=85\u0026s=2521f5f5ce4977d387d12aa169a8ee55","dark":"https://mintcdn.com/hyperline/G-7ZQgHUOVHWwtUN/layout/logo-light.png?fit=max\u0026auto=format\u0026n=G-7ZQgHUOVHWwtUN\u0026q=85\u0026s=c81125a44e9fdf8006623ab1f597ce7f"},"favicon":"https://mintcdn.com/hyperline/xZrQhb6Rphak0y92/favicon.png?fit=max\u0026auto=format\u0026n=xZrQhb6Rphak0y92\u0026q=85\u0026s=c52ed2ba655f301d3a99a7987888c622","api":{"openapi":["https://api.hyperline.co/openapi","https://ingest.hyperline.co/openapi"],"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":["https://api.hyperline.co","https://ingest.hyperline.co"]}},"appearance":{"default":"light"},"background":{"color":{"light":"#fafafa","dark":"#1f1f1f"}},"navbar":{"links":[{"href":"https://www.hyperline.co/talk-to-sales","label":"Book a call"}],"primary":{"type":"button","label":"Get Started","href":"https://app.hyperline.co"}},"footer":{"links":[{"header":"Resources","items":[{"label":"Status","href":"https://status.hyperline.co"},{"label":"Changelog","href":"https://docs.hyperline.co/changelog"},{"label":"Glossary","href":"https://docs.hyperline.co/docs/introduction/glossary"},{"label":"Contact support","href":"mailto:support@hyperline.co"}]},{"header":"Company","items":[{"label":"Customers","href":"https://www.hyperline.co/resources/customers"},{"label":"Blog","href":"https://www.hyperline.co/resources/blog"},{"label":"Careers","href":"https://www.welcometothejungle.com/fr/companies/hyperline"},{"label":"Media Kit","href":"https://drive.google.com/drive/folders/1KIlufVDz6tgwohTFFv1jSyoqeHO0pKOm"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://www.hyperline.co/privacy-policy"},{"label":"Terms of Service","href":"https://www.hyperline.co/terms-of-service"},{"label":"Security","href":"https://docs.hyperline.co/security"}]}]},"seo":{"metatags":{"og:image":"https://app.hyperline.co/auth/background.svg"},"indexing":"navigable"},"fonts":{"family":"Inter"},"integrations":{"posthog":{"apiKey":"phc_KmmpIQ7SFNwnur6ZqVC118l5EkS1pqo313t4qxwL32n","apiHost":"https://eu.posthog.com"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hyperline","hasAudioNarration":false,"actualSubdomain":"hyperline","customDomains":["docs.hyperline.co"],"gitSource":{"type":"github","owner":"meterly","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afb4f7c5b1cae9d19cf5a5d","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"Developers","count":363},{"language":"default","tag":"API reference","count":348},{"language":"default","tag":"Documentation","count":112},{"language":"default","tag":"Customers","count":58},{"language":"default","tag":"Subscriptions","count":54},{"language":"default","tag":"Catalog","count":52},{"language":"default","tag":"Accounting","count":51},{"language":"default","tag":"Integrations","count":43},{"language":"default","tag":"Agents","count":39},{"language":"default","tag":"Billing","count":36}]},"assistantConfig":{"enableStarterQuestions":false,"deflection":{"enabled":true,"email":"support@hyperline.co","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"index.css","content":"a[href*=\"mintlify.com\"]{display:none;visibility:hidden}.text-2xl{font-weight:600}.tag-blue{height:20px;line-height:20px;display:inline-block;background:#93c5fd;margin:0;padding:0 6px;border-radius:4px;color:#0166ff;border:1px solid #0166ff;font-weight:600;font-size:12px}.tag-orange{height:20px;line-height:20px;display:inline-block;background:#fef9e0;margin:0;padding:0 6px;border-radius:4px;color:#da9e09;border:1px solid #da9e09;font-weight:600;font-size:12px}#footer>div>div:not(:first-child){display:none;visibility:hidden}"},{"filePath":"developers/getting-started.css","content":"#content-area:has(#developer-home){max-width:56rem;margin-inline:auto}"},{"filePath":"developers/api-navigation.css","content":"#sidebar-content button .nav-tag-pill-text{color:#737373;background-color:rgb(0 0 0 / 4%);font-weight:400;font-variant-numeric:tabular-nums}.dark #sidebar-content button .nav-tag-pill-text{color:#a3a3a3;background-color:rgb(255 255 255 / 6%)}#sidebar-content button svg[style*=\"arrow-turn-down-right.svg\"]{width:0.75rem;height:0.75rem;mask-size:contain;opacity:0.65;flex-shrink:0}"}],"page":{"pagePath":"api-reference/endpoints/invoices/list-invoices","slug":"/api-reference/endpoints/invoices/list-invoices","pageMetadata":{"openapi":"get /v2/invoices","title":"List invoices","description":"Retrieve existing invoices. By default, invoices with status open are not included.","href":"/api-reference/endpoints/invoices/list-invoices"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve existing invoices. By default, invoices with status open are not included.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /v2/invoices","title":"List invoices","description":"Retrieve existing invoices. By default, invoices with status open are not included.","href":"/api-reference/endpoints/invoices/list-invoices"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listInvoices","tags":["Invoices"],"security":["aa26e61e-54ec-470d-9d95-4089fe593c49"],"summary":"List invoices","description":"Retrieve existing invoices. By default, invoices with status open are not included.","parameters":["c8cd8cee-d3b5-4ac0-974c-c958d9d1b29b","f3d4ec26-8efb-4718-911e-e07c724887dc","0601a2fd-3e82-417b-a310-10e3e8b18352","8a4914d4-1c97-469c-80f2-6aab9074d8ff","8cb52c61-2f64-4f05-85a4-6528d7924b25","cf34e723-9658-4361-b0ed-eadac6c6187e","de85a051-24b7-41a1-af24-fc43b10cf34b","ee0612be-486b-48c5-8d8f-dc76c634fba4","7f2eab37-472e-4198-ad52-aee364679ad1","b78e7e06-e23a-4a44-be6d-94ab3b7998cd","93a6af7a-5153-407f-b0c1-3438d003f197","f8c039d1-7497-487e-8373-5b426332474e","510b577b-34a1-4dc5-98af-99796bda4ec1","307d1d7a-65e7-4a3d-bda4-4a83c1632cd1","60094bda-f62e-44a9-8abb-9649b3123309","a2e57d97-6a23-4172-96f5-2ce8cd4c926c","3f84a78c-4dda-4e2a-b613-0a0de9d7aaee","7066b56a-48be-4dbb-9795-88255ab6f29f","f2cba0c4-4611-4735-8a6b-9cec9a3c44ae","3715b11f-1c80-4c16-ace9-6914e1158e9f","2bbdf283-687b-438d-b95a-b48c58b842ed","363207ae-cd08-43b7-8343-23a59915ad49","dd07f0ed-4e42-4711-81a4-e909b13b4606","4fbdb722-5935-41df-a478-e48b3e7acee2","7764bf47-51ad-4d6e-af5d-656c641a7e7b","f903516a-fe03-4426-8b86-7d0c56ca333e","ed12ee42-a08b-48cb-a476-d943c89bfb6e","1dcb8ad9-6481-4951-9eab-ba08ccf8feeb","8da5bca8-936e-4a21-af41-70ab7d1706ed","02fc69bf-1e7f-4963-bfd0-e7919a100395","7bce7945-2e28-458b-a2e0-87c4d0fe43e6","7e8648ed-35dd-4ff3-845f-4f372099556d","f0600d0a-a912-4c7f-9c70-39b1ee3d3859","866d43f9-74a3-488b-b4b0-6ffda6c8c39d","587117c3-19bd-48e4-ba21-7895d85f5b5d","75df4b5a-0052-4a77-ac47-2559a6347141","98395b11-49ed-461b-ad9b-5e6599f339f7","f3d50a29-a16a-474b-b683-8b6ed2128c8c","3bdfeb86-4702-44f9-9667-87d7e6fd4a9a","a452a654-106a-46ea-9f6e-17c315eb167d","3aad2132-166a-436e-9b1c-b0593fc6f112","acd50b9f-9278-4f71-8e3c-c34e7ba46e11","ca275545-cd7d-4da4-ac14-d6d2e5448f87","dfc0b9d2-35dc-4ae8-9813-d60041498ca1","43af7bfc-e75d-4653-b716-29656c2bc79e","bbe0d632-004c-44f8-a822-d771956fc8bf","a3e4483e-78c0-493a-ad0d-0f4a46f0f337","4d0e1ae0-98ac-485d-8266-707b4f14549a","3e85022f-f881-4359-b059-ebdc2f62a842","6d67bfb0-9023-4efa-955c-4161ee4278f5","3b1a145b-ab38-4a40-b54f-1c4ef632ef93","6fa13e6f-8969-43fb-b097-d396090bc2a9","e2084ae9-560f-4682-b0d7-8196a5103842","2ed59dff-bc90-4a82-ad82-db1233325966","fe2a033d-d45d-4619-bc32-9af13a385dd3","eacbab15-14ad-4b23-a1cd-8c6f65eaeafe","b11e5cc4-c20c-4073-8b2c-0ac875fb0202","6efc2cfd-cd38-41b9-b0bf-9020cdbd4c29","bd751c7e-c534-4871-b917-c3382b558853","4edd4ad0-6de7-4e64-bfb3-25998395c575","10e9ad23-525c-4914-b4f2-a7a1bd9f755a","d0064035-1f5d-460c-8de7-9a1ec57a57d9","6e1b565e-e4d8-4914-a152-e5d9dea521ab","b8d2a378-394b-4eb6-b34a-a97b9a359d45","cb67ada3-c77b-48e8-a3c7-df2743815ab1","1b240c14-3d4f-4688-b043-07d02c6d439a","51ef9bf6-9d8f-45dd-a90f-d53112ec9e16","3866a59e-f7d6-4fbb-94e1-772ff39bf4ad","f5c5c588-1b7b-4412-8020-a5218f88abcc","995a1c55-104c-4817-b023-a98bafd82cf6","78622be6-58c6-4d41-a31d-b4379cd206d3","c09b1c85-49a6-4142-ab9f-3f1a4040a344","de7a8141-17e9-4144-83e1-f10483ad07ca","de91300d-5c19-41de-b85b-dad9ebbe83ba","f0981747-b352-44f1-be64-7264c56e095f","5339695b-dab7-4d3a-ba65-96ecdbb1f0f3","b7bd607f-53f4-40e5-98e3-89236ddaf270","ffc53b83-f753-424f-9dcd-076d1f740b73","1698b85d-ce3a-4dc4-bac9-357d85da8a9b","69363e49-091b-4378-98bf-7f78b9021231","7601556d-e2c8-4c9f-8570-91b803067f84","f9ca989f-68c3-4298-84d4-4c00c01ebdd7","81d78b95-62d4-4f6a-ab42-84ab118876d2","97fb7e27-0d70-4d70-9876-66b7eb179503","60a95ab5-a51f-443d-a9a8-a9278c031428","ee08c5e1-c75b-428b-bba4-34f6bca555dd","f1221106-9df1-4308-b553-fd397cf765cc","c22c6865-b58a-43f5-be97-9d89985c6c11","e4335032-6fe3-47c8-9e48-e5a4c100cfc2","0e0d9a04-6b29-43a1-8e4a-8ed329de96e0","15ec1f8c-ae9b-48fa-b7fa-d2df183f081d","28629d20-a705-4805-912a-b5b89c726d46","24590b81-4515-4b5d-9966-8f30c2ab8b30","3718c231-0370-4317-b49c-cb93396896a0"],"responses":{"200":"05e04458-1da3-4568-8a5c-f648cf3dee1c"},"method":"get","type":"path","servers":["da140594-2292-43c7-96f8-2d99b8bb723e","94e9cc11-bd27-48d9-8471-85b725affa48"],"path":"/v2/invoices","baseUrlOptions":["https://api.hyperline.co","https://sandbox.api.hyperline.co"],"title":"List invoices","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c8cd8cee-d3b5-4ac0-974c-c958d9d1b29b":{"schema":{"type":"number","exclusiveMinimum":0,"maximum":100,"default":50,"description":"Maximum number of items to return (1-100).","example":50,"isRequired":false,"uniqueKey":"","typeLabel":"number"},"required":false,"description":"Maximum number of items to return (1-100).","name":"limit","in":"query"},"f3d4ec26-8efb-4718-911e-e07c724887dc":{"schema":{"type":"string","description":"Opaque cursor returned in the previous response's `next_cursor`. Omit to fetch the first page.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Opaque cursor returned in the previous response's `next_cursor`. Omit to fetch the first page.","name":"cursor","in":"query"},"0601a2fd-3e82-417b-a310-10e3e8b18352":{"schema":{"oneOf":[{"type":"boolean","description":"Set to `true` to include `total` in the response.","default":false,"example":false,"uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","description":"Set to `true` to include `total` in the response.","default":false,"enum":["true","false"],"example":false,"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | enum\u003cstring>"},"required":false,"description":"Set to `true` to include `total` in the response.","name":"include_total","in":"query"},"8a4914d4-1c97-469c-80f2-6aab9074d8ff":{"schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort direction.","example":"desc","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"Sort direction.","name":"order","in":"query"},"8cb52c61-2f64-4f05-85a4-6528d7924b25":{"schema":{"type":"string","enum":["created_at","emitted_at"],"description":"Field used to sort the results.","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"Field used to sort the results.","name":"sort","in":"query"},"cf34e723-9658-4361-b0ed-eadac6c6187e":{"schema":{"oneOf":[{"type":"string","enum":["invoice","refund","document","child_invoice_ref","child_creditnote_ref"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"invoice,refund","uniqueKey":"oneOf.1","typeLabel":"string"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | string"},"required":false,"name":"type","in":"query"},"de85a051-24b7-41a1-af24-fc43b10cf34b":{"schema":{"oneOf":[{"type":"string","enum":["invoice","refund","document","child_invoice_ref","child_creditnote_ref"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"invoice,refund","uniqueKey":"oneOf.1","typeLabel":"string"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | string"},"required":false,"name":"type__in","in":"query"},"ee0612be-486b-48c5-8d8f-dc76c634fba4":{"schema":{"oneOf":[{"type":"string","enum":["all","open","grace_period","to_pay","to_reconcile","error","paid","settleable","finalized","partially_paid","outstanding","refunded","late","draft","pending_approval","changes_requested","voided","closed","uncollectible","pending_consolidation","consolidated"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"all,open","uniqueKey":"oneOf.1","typeLabel":"string"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | string"},"required":false,"name":"status","in":"query"},"7f2eab37-472e-4198-ad52-aee364679ad1":{"schema":{"oneOf":[{"type":"string","enum":["all","open","grace_period","to_pay","to_reconcile","error","paid","settleable","finalized","partially_paid","outstanding","refunded","late","draft","pending_approval","changes_requested","voided","closed","uncollectible","pending_consolidation","consolidated"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"all,open","uniqueKey":"oneOf.1","typeLabel":"string"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | string"},"required":false,"name":"status__in","in":"query"},"b78e7e06-e23a-4a44-be6d-94ab3b7998cd":{"schema":{"oneOf":[{"type":"string","enum":["subscription","quote","wallet","customer_credits","invoice","manual","import"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"subscription,quote","uniqueKey":"oneOf.1","typeLabel":"string"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | string"},"required":false,"name":"origin","in":"query"},"93a6af7a-5153-407f-b0c1-3438d003f197":{"schema":{"oneOf":[{"type":"string","enum":["subscription","quote","wallet","customer_credits","invoice","manual","import"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"subscription,quote","uniqueKey":"oneOf.1","typeLabel":"string"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | string"},"required":false,"name":"origin__in","in":"query"},"f8c039d1-7497-487e-8373-5b426332474e":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_id","in":"query"},"510b577b-34a1-4dc5-98af-99796bda4ec1":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_id__not","in":"query"},"307d1d7a-65e7-4a3d-bda4-4a83c1632cd1":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_id__equals","in":"query"},"60094bda-f62e-44a9-8abb-9649b3123309":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_id__contains","in":"query"},"a2e57d97-6a23-4172-96f5-2ce8cd4c926c":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_id__startsWith","in":"query"},"3f84a78c-4dda-4e2a-b613-0a0de9d7aaee":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_id__endWith","in":"query"},"7066b56a-48be-4dbb-9795-88255ab6f29f":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_external_id","in":"query"},"f2cba0c4-4611-4735-8a6b-9cec9a3c44ae":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"subscription_id","in":"query"},"3715b11f-1c80-4c16-ace9-6914e1158e9f":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"subscription_id__not","in":"query"},"2bbdf283-687b-438d-b95a-b48c58b842ed":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"subscription_id__equals","in":"query"},"363207ae-cd08-43b7-8343-23a59915ad49":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"subscription_id__contains","in":"query"},"dd07f0ed-4e42-4711-81a4-e909b13b4606":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"subscription_id__startsWith","in":"query"},"4fbdb722-5935-41df-a478-e48b3e7acee2":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"subscription_id__endWith","in":"query"},"7764bf47-51ad-4d6e-af5d-656c641a7e7b":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"subscription_id__isNull","in":"query"},"f903516a-fe03-4426-8b86-7d0c56ca333e":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"subscription_id__isNotNull","in":"query"},"ed12ee42-a08b-48cb-a476-d943c89bfb6e":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"invoicing_entity_id","in":"query"},"1dcb8ad9-6481-4951-9eab-ba08ccf8feeb":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"invoicing_entity_id__not","in":"query"},"8da5bca8-936e-4a21-af41-70ab7d1706ed":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"invoicing_entity_id__equals","in":"query"},"02fc69bf-1e7f-4963-bfd0-e7919a100395":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"invoicing_entity_id__contains","in":"query"},"7bce7945-2e28-458b-a2e0-87c4d0fe43e6":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"invoicing_entity_id__startsWith","in":"query"},"7e8648ed-35dd-4ff3-845f-4f372099556d":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"invoicing_entity_id__endWith","in":"query"},"f0600d0a-a912-4c7f-9c70-39b1ee3d3859":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"invoice_number","in":"query"},"866d43f9-74a3-488b-b4b0-6ffda6c8c39d":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"invoice_number__not","in":"query"},"587117c3-19bd-48e4-ba21-7895d85f5b5d":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"invoice_number__equals","in":"query"},"75df4b5a-0052-4a77-ac47-2559a6347141":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"invoice_number__contains","in":"query"},"98395b11-49ed-461b-ad9b-5e6599f339f7":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"invoice_number__startsWith","in":"query"},"f3d50a29-a16a-474b-b683-8b6ed2128c8c":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"invoice_number__endWith","in":"query"},"3bdfeb86-4702-44f9-9667-87d7e6fd4a9a":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"original_invoice_id","in":"query"},"a452a654-106a-46ea-9f6e-17c315eb167d":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"original_invoice_id__not","in":"query"},"3aad2132-166a-436e-9b1c-b0593fc6f112":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"original_invoice_id__equals","in":"query"},"acd50b9f-9278-4f71-8e3c-c34e7ba46e11":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"original_invoice_id__contains","in":"query"},"ca275545-cd7d-4da4-ac14-d6d2e5448f87":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"original_invoice_id__startsWith","in":"query"},"dfc0b9d2-35dc-4ae8-9813-d60041498ca1":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"original_invoice_id__endWith","in":"query"},"43af7bfc-e75d-4653-b716-29656c2bc79e":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"original_invoice_id__isNull","in":"query"},"bbe0d632-004c-44f8-a822-d771956fc8bf":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"original_invoice_id__isNotNull","in":"query"},"a3e4483e-78c0-493a-ad0d-0f4a46f0f337":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"original_invoice_number","in":"query"},"4d0e1ae0-98ac-485d-8266-707b4f14549a":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"original_invoice_number__not","in":"query"},"3e85022f-f881-4359-b059-ebdc2f62a842":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"original_invoice_number__equals","in":"query"},"6d67bfb0-9023-4efa-955c-4161ee4278f5":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"original_invoice_number__contains","in":"query"},"3b1a145b-ab38-4a40-b54f-1c4ef632ef93":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"original_invoice_number__startsWith","in":"query"},"6fa13e6f-8969-43fb-b097-d396090bc2a9":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"original_invoice_number__endWith","in":"query"},"e2084ae9-560f-4682-b0d7-8196a5103842":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"original_invoice_number__isNull","in":"query"},"2ed59dff-bc90-4a82-ad82-db1233325966":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"original_invoice_number__isNotNull","in":"query"},"fe2a033d-d45d-4619-bc32-9af13a385dd3":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"line_item_id","in":"query"},"eacbab15-14ad-4b23-a1cd-8c6f65eaeafe":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_start","in":"query"},"b11e5cc4-c20c-4073-8b2c-0ac875fb0202":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_start__not","in":"query"},"6efc2cfd-cd38-41b9-b0bf-9020cdbd4c29":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_start__equals","in":"query"},"bd751c7e-c534-4871-b917-c3382b558853":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_start__lt","in":"query"},"4edd4ad0-6de7-4e64-bfb3-25998395c575":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_start__lte","in":"query"},"10e9ad23-525c-4914-b4f2-a7a1bd9f755a":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_start__gt","in":"query"},"d0064035-1f5d-460c-8de7-9a1ec57a57d9":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_start__gte","in":"query"},"6e1b565e-e4d8-4914-a152-e5d9dea521ab":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"period_start__isNull","in":"query"},"b8d2a378-394b-4eb6-b34a-a97b9a359d45":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"period_start__isNotNull","in":"query"},"cb67ada3-c77b-48e8-a3c7-df2743815ab1":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_end","in":"query"},"1b240c14-3d4f-4688-b043-07d02c6d439a":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_end__not","in":"query"},"51ef9bf6-9d8f-45dd-a90f-d53112ec9e16":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_end__equals","in":"query"},"3866a59e-f7d6-4fbb-94e1-772ff39bf4ad":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_end__lt","in":"query"},"f5c5c588-1b7b-4412-8020-a5218f88abcc":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_end__lte","in":"query"},"995a1c55-104c-4817-b023-a98bafd82cf6":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_end__gt","in":"query"},"78622be6-58c6-4d41-a31d-b4379cd206d3":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"period_end__gte","in":"query"},"c09b1c85-49a6-4142-ab9f-3f1a4040a344":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"period_end__isNull","in":"query"},"de7a8141-17e9-4144-83e1-f10483ad07ca":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"period_end__isNotNull","in":"query"},"de91300d-5c19-41de-b85b-dad9ebbe83ba":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"issued_at","in":"query"},"f0981747-b352-44f1-be64-7264c56e095f":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"issued_at__not","in":"query"},"5339695b-dab7-4d3a-ba65-96ecdbb1f0f3":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"issued_at__equals","in":"query"},"b7bd607f-53f4-40e5-98e3-89236ddaf270":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"issued_at__lt","in":"query"},"ffc53b83-f753-424f-9dcd-076d1f740b73":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"issued_at__lte","in":"query"},"1698b85d-ce3a-4dc4-bac9-357d85da8a9b":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"issued_at__gt","in":"query"},"69363e49-091b-4378-98bf-7f78b9021231":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"issued_at__gte","in":"query"},"7601556d-e2c8-4c9f-8570-91b803067f84":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"due_at","in":"query"},"f9ca989f-68c3-4298-84d4-4c00c01ebdd7":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"due_at__not","in":"query"},"81d78b95-62d4-4f6a-ab42-84ab118876d2":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"due_at__equals","in":"query"},"97fb7e27-0d70-4d70-9876-66b7eb179503":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"due_at__lt","in":"query"},"60a95ab5-a51f-443d-a9a8-a9278c031428":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"due_at__lte","in":"query"},"ee08c5e1-c75b-428b-bba4-34f6bca555dd":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"due_at__gt","in":"query"},"f1221106-9df1-4308-b553-fd397cf765cc":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"due_at__gte","in":"query"},"c22c6865-b58a-43f5-be97-9d89985c6c11":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at","in":"query"},"e4335032-6fe3-47c8-9e48-e5a4c100cfc2":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at__not","in":"query"},"0e0d9a04-6b29-43a1-8e4a-8ed329de96e0":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at__equals","in":"query"},"15ec1f8c-ae9b-48fa-b7fa-d2df183f081d":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at__lt","in":"query"},"28629d20-a705-4805-912a-b5b89c726d46":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at__lte","in":"query"},"24590b81-4515-4b5d-9966-8f30c2ab8b30":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at__gt","in":"query"},"3718c231-0370-4317-b49c-cb93396896a0":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at__gte","in":"query"}},"responses":{"05e04458-1da3-4568-8a5c-f648cf3dee1c":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Invoice ID.","example":"inv_1eTaiytfA0i2Va","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"number":{"type":"string","description":"Invoice number. Generated by Hyperline using the sequential numbering and format defined in your settings.","example":"INV-35","isRequired":true,"uniqueKey":"data.items.[INDEX].number","typeLabel":"string"},"type":{"type":"string","enum":["invoice","credit_note","document","child_invoice_ref","child_creditnote_ref"],"description":"Type of the invoice.\n\n- `invoice`: Legal invoice to be paid by your customer.\n- `credit_note`: Legal credit note cancelling an invoice and refunding your customer.\n- `document`: Custom document with no legal value. Can be generated from a subscription to meet specific needs.\n ","example":"invoice","isRequired":true,"uniqueKey":"data.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"document_name":{"oneOf":[{"type":"string","description":"If the invoice is of type `document` you can give it a custom name (displayed on the final PDF).","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].document_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"If the invoice is of type `document` you can give it a custom name (displayed on the final PDF).","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].document_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].document_name","typeLabel":"string | null"},"status":{"type":"string","enum":["draft","pending_approval","changes_requested","open","to_pay","grace_period","partially_paid","paid","voided","closed","error","missing_info","archived","charged_on_parent","pending_parent_concat","pending_consolidation","consolidated","uncollectible"],"description":"Current invoice status.\n\n- `draft`: Invoice is in draft mode (not finalized yet).\n- `open`: Invoice for the current billing period, which will be issued at the end of the period (used for invoices with usage-based data).\n- `grace_period`: Invoice is in a review period after being issued for the billing period and before becoming due for payment.\n- `to_pay`: Invoice is awaiting payment.\n- `partially_paid`: Invoice is partially paid.\n- `paid`: Invoice is fully paid.\n- `voided`: Invoice has been voided and is no longer valid.\n- `closed`: Invoice was not issued and has been discarded.\n- `error`: Invoice failed to be paid.\n- `archived`: A previous version of an invoice.\n- `charged_on_parent`: Invoice is charged on the parent customer.\n- `pending_parent_concat`: Invoice is pending invoices concatenation on the parent customer to be grouped.\n- `uncollectible`: Invoice is uncollectible (bad debt). Only metadata (properties, custom_note, custom_properties) can be updated in this status.\n","example":"paid","isRequired":true,"uniqueKey":"data.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"reference":{"oneOf":[{"type":"string","description":"Unique identifier to ease reconciliation with payment. Useful for bank transfer.","example":"V0KAHOU6J3","isRequired":true,"uniqueKey":"data.items.[INDEX].reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier to ease reconciliation with payment. Useful for bank transfer.","example":"V0KAHOU6J3","isRequired":true,"uniqueKey":"data.items.[INDEX].reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].reference","typeLabel":"string | null"},"purchase_order":{"oneOf":[{"type":"string","description":"Reference to the purchase order linked to the invoice.","example":"PO-12345","isRequired":true,"uniqueKey":"data.items.[INDEX].purchase_order.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reference to the purchase order linked to the invoice.","example":"PO-12345","isRequired":true,"uniqueKey":"data.items.[INDEX].purchase_order.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].purchase_order","typeLabel":"string | null"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"source":{"type":"string","enum":["hyperline","api","pennylane","chargebee","stripe","lago","sequence","other"],"description":"Source of the invoice.\n - `hyperline`: Invoice created by Hyperline.\n - `api`: Invoice created through the API.\n - `other`: Invoice created by an external source.\n","example":"hyperline","isRequired":true,"uniqueKey":"data.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["subscription","quote","wallet","customer_credits","invoice","manual","import"],"description":"What generated the invoice, whatever the channel used to create it (see `source`). New values may be added.\n - `subscription`: Generated by a subscription: renewal, update, transition, cancellation, reactivation or reinstatement.\n - `quote`: Generated by a quote.\n - `wallet`: Wallet top-up, free credits granted or expiration of the remaining balance.\n - `customer_credits`: Purchase of customer credits.\n - `invoice`: Built from other invoices: a credit note correcting an invoice, a consolidated invoice or an invoice re-billed to a parent organisation.\n - `manual`: Standalone invoice or credit note created by a user, in the app or through the API.\n - `import`: Imported from an external billing provider.\n","example":"subscription","isRequired":true,"uniqueKey":"data.items.[INDEX].origin","typeLabel":"enum\u003cstring>"},"total_amount":{"type":"number","description":"Sum of the amount and taxes amount of all products on the invoice. Expressed in currency's smallest unit.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].total_amount","typeLabel":"number"},"amount_due":{"type":"number","description":"Amount still need to be paid for the invoice. Expressed in currency's smallest unit.","example":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].amount_due","typeLabel":"number"},"amount_paid":{"type":"number","description":"Amount already paid for the invoice. Expressed in currency's smallest unit.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].amount_paid","typeLabel":"number"},"amount_fixed":{"type":"number","description":"Amount corresponding to the recurring non-variable part of the total amount. Expressed in currency's smallest unit.","example":20000,"isRequired":true,"uniqueKey":"data.items.[INDEX].amount_fixed","typeLabel":"number"},"amount_excluding_tax":{"type":"number","description":"Total amount without the taxes amount. Expressed in currency's smallest unit.","example":20000,"isRequired":true,"uniqueKey":"data.items.[INDEX].amount_excluding_tax","typeLabel":"number"},"tax_amount":{"type":"number","description":"Tax amount of the invoice. Expressed in currency's smallest unit.","example":4000,"isRequired":true,"uniqueKey":"data.items.[INDEX].tax_amount","typeLabel":"number"},"tax_scheme":{"type":"string","enum":["exempt","standard","reverse_charge","manual","not_eligible"],"description":"Tax scheme of the invoice.\n\n- `standard`: Tax rate is resolved depending on local tax regulations.\n- `exempt`: No tax rate applied because the customer country doesn't require it.\n- `reverse_charge`: No tax rate applied because the customer is eligible to EU reverse charge.\n- `manual`: Tax rate has been manually specified when creating the invoice.\n- `not_eligible`: Tax collection is disabled for the invoice.\n ","example":"standard","isRequired":true,"uniqueKey":"data.items.[INDEX].tax_scheme","typeLabel":"enum\u003cstring>"},"discount_amount":{"type":"number","description":"Amount corresponding to the discounted part of the total amount. Expressed in currency's smallest unit.","example":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].discount_amount","typeLabel":"number"},"conversion_rate":{"oneOf":[{"type":"number","description":"Conversion rate used between the invoice currency and your accounting currency.","example":1,"isRequired":true,"uniqueKey":"data.items.[INDEX].conversion_rate.oneOf.0","typeLabel":"number"},{"type":"null","description":"Conversion rate used between the invoice currency and your accounting currency.","example":1,"isRequired":true,"uniqueKey":"data.items.[INDEX].conversion_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].conversion_rate","typeLabel":"number | null"},"converted_amount":{"oneOf":[{"type":"number","description":"Amount converted using the conversion rate. Expressed in currency's smallest unit.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].converted_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Amount converted using the conversion rate. Expressed in currency's smallest unit.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].converted_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].converted_amount","typeLabel":"number | null"},"converted_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date of the conversion of the amount.","example":"2026-10-13T02:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].converted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date of the conversion of the amount.","example":"2026-10-13T02:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].converted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].converted_at","typeLabel":"string\u003cdate-time> | null"},"payment_method_id":{"oneOf":[{"type":"string","description":"ID of the default payment method used to pay the invoice. Transactions related to the invoice may use different payment methods.","example":"pm_1ryTrMj4TTAT1N","isRequired":true,"uniqueKey":"data.items.[INDEX].payment_method_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the default payment method used to pay the invoice. Transactions related to the invoice may use different payment methods.","example":"pm_1ryTrMj4TTAT1N","isRequired":true,"uniqueKey":"data.items.[INDEX].payment_method_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].payment_method_id","typeLabel":"string | null"},"bank_account_id":{"oneOf":[{"type":"string","description":"ID of the bank account displayed on the invoice. Transactions related to the invoice may use different bank accounts.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].bank_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the bank account displayed on the invoice. Transactions related to the invoice may use different bank accounts.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].bank_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].bank_account_id","typeLabel":"string | null"},"custom_note":{"oneOf":[{"type":"string","description":"Custom note added to the invoice.","example":"Thank you for your purchase!","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_note.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom note added to the invoice.","example":"Thank you for your purchase!","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_note.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].custom_note","typeLabel":"string | null"},"additional_info":{"oneOf":[{"type":"string","description":"Additional information added to the invoice. If not defined, it will be inherited from the invoicing entity's settings.","example":"This invoice must be paid within the payment delay indicated. After this period a late payment penalty of 10% will be applied.","isRequired":true,"uniqueKey":"data.items.[INDEX].additional_info.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional information added to the invoice. If not defined, it will be inherited from the invoicing entity's settings.","example":"This invoice must be paid within the payment delay indicated. After this period a late payment penalty of 10% will be applied.","isRequired":true,"uniqueKey":"data.items.[INDEX].additional_info.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].additional_info","typeLabel":"string | null"},"footer":{"oneOf":[{"type":"string","description":"Footer added to the invoice. If not defined, it will be inherited from the invoicing entity's settings.","example":"ACME (Acme SAS) is a company registered in France | SIREN N°123456","isRequired":true,"uniqueKey":"data.items.[INDEX].footer.oneOf.0","typeLabel":"string"},{"type":"null","description":"Footer added to the invoice. If not defined, it will be inherited from the invoicing entity's settings.","example":"ACME (Acme SAS) is a company registered in France | SIREN N°123456","isRequired":true,"uniqueKey":"data.items.[INDEX].footer.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].footer","typeLabel":"string | null"},"customer":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID.","example":"cus_Typ0px2W0aiEtl","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.id","typeLabel":"string"},"name":{"type":"string","description":"Customer name.","example":"Acme","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.name","typeLabel":"string"},"email":{"oneOf":[{"type":"string","description":"Email to which all communications will be sent.","example":"billing@acme.com","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email to which all communications will be sent.","example":"billing@acme.com","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].customer.email","typeLabel":"string | null"},"external_id":{"oneOf":[{"type":"string","description":"ID of the customer in your system. This helps matching your customer with the one on Hyperline. When external ID uniqueness is enforced for your account, two active customers cannot share the same external ID.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].customer.external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the customer in your system. This helps matching your customer with the one on Hyperline. When external ID uniqueness is enforced for your account, two active customers cannot share the same external ID.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].customer.external_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].customer.external_id","typeLabel":"string | null"},"tax_id":{"oneOf":[{"type":"string","description":"Value of the customer tax ID.","example":"FR123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.tax_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value of the customer tax ID.","example":"FR123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.tax_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].customer.tax_id","typeLabel":"string | null"},"local_tax_number":{"oneOf":[{"type":"string","description":"Customer local tax number.","example":"12/345/67890","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.local_tax_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer local tax number.","example":"12/345/67890","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.local_tax_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].customer.local_tax_number","typeLabel":"string | null"},"registration_number":{"oneOf":[{"type":"string","description":"Customer registration number.","example":"36252187900034","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.registration_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer registration number.","example":"36252187900034","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].customer.registration_number","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"Address name.","example":"Acme","uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address name.","example":"Acme","uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.name","typeLabel":"string | null"},"line1":{"oneOf":[{"type":"string","description":"Address first line.","example":"5 rue de Paradis","uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address first line.","example":"5 rue de Paradis","uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"Address second line (optional).","example":null,"uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address second line (optional).","example":null,"uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"Address city.","example":"Paris","uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address city.","example":"Paris","uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.city","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"Address ZIP code.","example":"75010","uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address ZIP code.","example":"75010","uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. `CA` for `US-CA`) for:\n- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)\n- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)\n- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)\n- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)\n\nA code or a name is accepted (e.g. `ON` or `Ontario`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.","example":"CA","uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. `CA` for `US-CA`) for:\n- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)\n- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)\n- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)\n- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)\n\nA code or a name is accepted (e.g. `ON` or `Ontario`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.","example":"CA","uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.state","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BF","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ES-CE","ES-ML","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PT-20","PT-30","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"FR","uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BF","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ES-CE","ES-ML","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PT-20","PT-30","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"FR","uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].customer.address.oneOf.0.country","typeLabel":"enum\u003cstring> | null"}},"description":"Customer billing address.","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.address.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"oneOf":[{"type":"string","description":"Address name.","example":"Acme"},{"type":"null","description":"Address name.","example":"Acme"}]},"line1":{"oneOf":[{"type":"string","description":"Address first line.","example":"5 rue de Paradis"},{"type":"null","description":"Address first line.","example":"5 rue de Paradis"}]},"line2":{"oneOf":[{"type":"string","description":"Address second line (optional).","example":null},{"type":"null","description":"Address second line (optional).","example":null}]},"city":{"oneOf":[{"type":"string","description":"Address city.","example":"Paris"},{"type":"null","description":"Address city.","example":"Paris"}]},"zip":{"oneOf":[{"type":"string","description":"Address ZIP code.","example":"75010"},{"type":"null","description":"Address ZIP code.","example":"75010"}]},"state":{"oneOf":[{"type":"string","description":"State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. `CA` for `US-CA`) for:\n- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)\n- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)\n- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)\n- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)\n\nA code or a name is accepted (e.g. `ON` or `Ontario`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.","example":"CA"},{"type":"null","description":"State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. `CA` for `US-CA`) for:\n- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)\n- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)\n- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)\n- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)\n\nA code or a name is accepted (e.g. `ON` or `Ontario`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.","example":"CA"}]},"country":{"oneOf":[{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BF","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ES-CE","ES-ML","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PT-20","PT-30","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"FR"},{"type":"null","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BF","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ES-CE","ES-ML","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PT-20","PT-30","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"FR"}]}},"description":"Customer billing address.","isRequired":true,"uniqueKey":"data.items.[INDEX].customer.address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].customer.address","typeLabel":"object | null"}},"required":["id","name","email","external_id","tax_id","local_tax_number","registration_number","address"],"isRequired":true,"uniqueKey":"data.items.[INDEX].customer","typeLabel":"object"},"seller":{"type":"object","properties":{"id":{"type":"string","description":"ID of the invoicing entity attached to the invoice.","example":"ive_47484fjdhy5","isRequired":true,"uniqueKey":"data.items.[INDEX].seller.id","typeLabel":"string"},"name":{"type":"string","description":"Name of the invoicing entity","example":"Name of the invoicing entity","isRequired":true,"uniqueKey":"data.items.[INDEX].seller.name","typeLabel":"string"},"tax_id":{"oneOf":[{"type":"string","description":"Tax identifier / VAT number of the invoicing entity","example":"FR5878986578","isRequired":true,"uniqueKey":"data.items.[INDEX].seller.tax_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tax identifier / VAT number of the invoicing entity","example":"FR5878986578","isRequired":true,"uniqueKey":"data.items.[INDEX].seller.tax_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].seller.tax_id","typeLabel":"string | null"},"registration_number":{"oneOf":[{"type":"string","description":"Legal registration number of the invoicing entity, as it stood when the invoice was emitted.","example":"87898657800016","isRequired":true,"uniqueKey":"data.items.[INDEX].seller.registration_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Legal registration number of the invoicing entity, as it stood when the invoice was emitted.","example":"87898657800016","isRequired":true,"uniqueKey":"data.items.[INDEX].seller.registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].seller.registration_number","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","description":"Seller address.","properties":{"name":{"oneOf":[{"type":"string","description":"Address name.","example":"Acme","uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address name.","example":"Acme","uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.name","typeLabel":"string | null"},"line1":{"oneOf":[{"type":"string","description":"Address first line.","example":"5 rue de Paradis","uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address first line.","example":"5 rue de Paradis","uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"Address second line (optional).","example":null,"uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address second line (optional).","example":null,"uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"Address city.","example":"Paris","uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address city.","example":"Paris","uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.city","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"Address ZIP code.","example":"75010","uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address ZIP code.","example":"75010","uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. `CA` for `US-CA`) for:\n- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)\n- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)\n- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)\n- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)\n\nA code or a name is accepted (e.g. `ON` or `Ontario`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.","example":"CA","uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. `CA` for `US-CA`) for:\n- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)\n- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)\n- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)\n- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)\n\nA code or a name is accepted (e.g. `ON` or `Ontario`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.","example":"CA","uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.state","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BF","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ES-CE","ES-ML","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PT-20","PT-30","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"FR","uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BF","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ES-CE","ES-ML","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PT-20","PT-30","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"FR","uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].seller.address.oneOf.0.country","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].seller.address.oneOf.0","typeLabel":"object"},{"type":"null","description":"Seller address.","properties":{"name":{"oneOf":[{"type":"string","description":"Address name.","example":"Acme"},{"type":"null","description":"Address name.","example":"Acme"}]},"line1":{"oneOf":[{"type":"string","description":"Address first line.","example":"5 rue de Paradis"},{"type":"null","description":"Address first line.","example":"5 rue de Paradis"}]},"line2":{"oneOf":[{"type":"string","description":"Address second line (optional).","example":null},{"type":"null","description":"Address second line (optional).","example":null}]},"city":{"oneOf":[{"type":"string","description":"Address city.","example":"Paris"},{"type":"null","description":"Address city.","example":"Paris"}]},"zip":{"oneOf":[{"type":"string","description":"Address ZIP code.","example":"75010"},{"type":"null","description":"Address ZIP code.","example":"75010"}]},"state":{"oneOf":[{"type":"string","description":"State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. `CA` for `US-CA`) for:\n- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)\n- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)\n- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)\n- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)\n\nA code or a name is accepted (e.g. `ON` or `Ontario`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.","example":"CA"},{"type":"null","description":"State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. `CA` for `US-CA`) for:\n- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)\n- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)\n- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)\n- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)\n\nA code or a name is accepted (e.g. `ON` or `Ontario`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.","example":"CA"}]},"country":{"oneOf":[{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BF","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ES-CE","ES-ML","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PT-20","PT-30","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"FR"},{"type":"null","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BF","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ES-CE","ES-ML","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PT-20","PT-30","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"FR"}]}},"isRequired":true,"uniqueKey":"data.items.[INDEX].seller.address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].seller.address","typeLabel":"object | null"}},"required":["id","name","tax_id","registration_number","address"],"isRequired":true,"uniqueKey":"data.items.[INDEX].seller","typeLabel":"object"},"subscription_id":{"oneOf":[{"type":"string","description":"ID of the subscription related to the invoice.","example":"sub_amiaWZ3lzDIWaoT","isRequired":true,"uniqueKey":"data.items.[INDEX].subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the subscription related to the invoice.","example":"sub_amiaWZ3lzDIWaoT","isRequired":true,"uniqueKey":"data.items.[INDEX].subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].subscription_id","typeLabel":"string | null"},"period_starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the billing period of the invoice.","example":"2026-10-13T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].period_starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date of the billing period of the invoice.","example":"2026-10-13T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].period_starts_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].period_starts_at","typeLabel":"string\u003cdate-time> | null"},"period_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the billing period of the invoice.","example":"2026-11-13T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].period_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the billing period of the invoice.","example":"2026-11-13T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].period_ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].period_ends_at","typeLabel":"string\u003cdate-time> | null"},"due_at":{"type":"string","format":"date-time","description":"Due date of the invoice. Computed from the issue date and the payment delay configured in your settings.","example":"2026-11-12T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].due_at","typeLabel":"string\u003cdate-time>"},"issuing_method":{"type":"string","enum":["manual","scheduled"],"description":"\nHow the invoice is issued.\n\n- `manual`: Issued when finalized, by a user or by the invoicing flow.\n- `scheduled`: Draft finalized automatically at the start of its issue date (`issued_at`), in the invoice timezone.\n","example":"manual","isRequired":true,"uniqueKey":"data.items.[INDEX].issuing_method","typeLabel":"enum\u003cstring>"},"refunded_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the refund of the invoice, previously paid. A credit note exists with an original invoice ID equals to this invoice ID.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].refunded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the refund of the invoice, previously paid. A credit note exists with an original invoice ID equals to this invoice ID.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].refunded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].refunded_at","typeLabel":"string\u003cdate-time> | null"},"grace_period_ended_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date the invoice grace period ended. This happens at the issue date + the grace period duration configured in your settings.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].grace_period_ended_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date the invoice grace period ended. This happens at the issue date + the grace period duration configured in your settings.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].grace_period_ended_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].grace_period_ended_at","typeLabel":"string\u003cdate-time> | null"},"settled_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date the invoice was fully paid.","example":"2026-10-15T14:01:56.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].settled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date the invoice was fully paid.","example":"2026-10-15T14:01:56.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].settled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].settled_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date of the last update.","example":"2026-10-15T14:01:56.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date of the last update.","example":"2026-10-15T14:01:56.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time> | null"},"properties":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties.oneOf.4.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties.oneOf.4.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties.oneOf.4.items.[INDEX].oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties.oneOf.4.items.[INDEX].oneOf.3","typeLabel":"null"},{"type":"null","uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties.oneOf.4.items.[INDEX].oneOf.4","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string · number · boolean · null · null"},"uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties.oneOf.4","typeLabel":"string · number · boolean · null · null[]"},{"type":"null","uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].properties.oneOf.0.additionalProperties","typeLabel":"string · number · boolean · null · string · number · boolean · null · null[] · null"},"description":"Key/value pairs to store any metadata useful in your context.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].properties.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties.oneOf.4.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties.oneOf.4.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties.oneOf.4.items.[INDEX].oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties.oneOf.4.items.[INDEX].oneOf.3","typeLabel":"null"},{"type":"null","uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties.oneOf.4.items.[INDEX].oneOf.4","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string · number · boolean · null · null"},"uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties.oneOf.4","typeLabel":"string · number · boolean · null · null[]"},{"type":"null","uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].properties.oneOf.1.additionalProperties","typeLabel":"string · number · boolean · null · string · number · boolean · null · null[] · null"},"description":"Key/value pairs to store any metadata useful in your context.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].properties.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].properties","typeLabel":"object | null"},"custom_properties":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].custom_properties.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].custom_properties.oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].custom_properties.oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","description":"UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].custom_properties.oneOf.0.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].custom_properties.oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].custom_properties.oneOf.0.additionalProperties.oneOf.4","typeLabel":"string[]"},{"type":"null","uniqueKey":"data.items.[INDEX].custom_properties.oneOf.0.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].custom_properties.oneOf.0.additionalProperties","typeLabel":"string | number | boolean | string\u003cdate-time> | string[] | null"},"description":"Values for custom properties defined for the `invoice` entity, keyed by slug.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].custom_properties.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].custom_properties.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].custom_properties.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].custom_properties.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","description":"UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].custom_properties.oneOf.1.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].custom_properties.oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].custom_properties.oneOf.1.additionalProperties.oneOf.4","typeLabel":"string[]"},{"type":"null","uniqueKey":"data.items.[INDEX].custom_properties.oneOf.1.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].custom_properties.oneOf.1.additionalProperties","typeLabel":"string | number | boolean | string\u003cdate-time> | string[] | null"},"description":"Values for custom properties defined for the `invoice` entity, keyed by slug.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].custom_properties.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].custom_properties","typeLabel":"object | null"},"additional_display_fields":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","title":"Standard field","required":["type","field"],"properties":{"type":{"type":"string","enum":["standard"],"description":"Display a standard invoice field.","isRequired":true,"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.0.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"field":{"type":"string","enum":["customer_id","subscription_id","quote_id"],"description":"Standard invoice field to display.","isRequired":true,"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.0.items.[INDEX].oneOf.0.field","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"Standard field · object"},{"type":"object","title":"Custom property","required":["type","slug"],"properties":{"type":{"type":"string","enum":["custom_property"],"description":"Display an invoice or customer custom property.","isRequired":true,"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.0.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"slug":{"type":"string","description":"Slug of the invoice or customer custom property to display.","isRequired":true,"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.0.items.[INDEX].oneOf.1.slug","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"Custom property · object"},{"type":"object","title":"Custom text","required":["type","label","value"],"properties":{"type":{"type":"string","enum":["custom"],"description":"Display a custom label and value.","isRequired":true,"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.0.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"label":{"type":"string","minLength":1,"maxLength":100,"description":"Label displayed on the invoice.","isRequired":true,"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.0.items.[INDEX].oneOf.2.label","typeLabel":"string"},"value":{"type":"string","maxLength":500,"description":"Value displayed on the invoice.","isRequired":true,"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.0.items.[INDEX].oneOf.2.value","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.0.items.[INDEX].oneOf.2","typeLabel":"Custom text · object"}],"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.0.items.[INDEX]","typeLabel":"Standard field · object | Custom property · object | Custom text · object"},"maxItems":20,"description":"Ordered additional fields displayed on the invoice PDF. Invoice and customer custom properties are referenced by slug.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.0","typeLabel":"(Standard field · object | Custom property · object | Custom text · object)[]"},{"type":"null","items":{"oneOf":[{"type":"object","title":"Standard field","required":["type","field"],"properties":{"type":{"type":"string","enum":["standard"],"description":"Display a standard invoice field."},"field":{"type":"string","enum":["customer_id","subscription_id","quote_id"],"description":"Standard invoice field to display."}}},{"type":"object","title":"Custom property","required":["type","slug"],"properties":{"type":{"type":"string","enum":["custom_property"],"description":"Display an invoice or customer custom property."},"slug":{"type":"string","description":"Slug of the invoice or customer custom property to display."}}},{"type":"object","title":"Custom text","required":["type","label","value"],"properties":{"type":{"type":"string","enum":["custom"],"description":"Display a custom label and value."},"label":{"type":"string","minLength":1,"maxLength":100,"description":"Label displayed on the invoice."},"value":{"type":"string","maxLength":500,"description":"Value displayed on the invoice."}}}]},"maxItems":20,"description":"Ordered additional fields displayed on the invoice PDF. Invoice and customer custom properties are referenced by slug.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].additional_display_fields.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].additional_display_fields","typeLabel":"(Standard field · object | Custom property · object | Custom text · object)[] | null"},"original_invoice_id":{"oneOf":[{"type":"string","description":"ID of the reference invoice this entity is linked to. For credit notes, this is not necessarily an invoice receiving credit; use `allocations` for applications.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].original_invoice_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the reference invoice this entity is linked to. For credit notes, this is not necessarily an invoice receiving credit; use `allocations` for applications.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].original_invoice_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].original_invoice_id","typeLabel":"string | null"},"original_invoice_number":{"oneOf":[{"type":"string","description":"Number of the original invoice this entity is linked to (only used for credit note).","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].original_invoice_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Number of the original invoice this entity is linked to (only used for credit note).","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].original_invoice_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].original_invoice_number","typeLabel":"string | null"},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Invoice line item ID.","example":"ili_0FACNpeoEFkGu3","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Name of the line item, corresponding to the related product.","example":"Platform access","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].name","typeLabel":"string"},"entry_type":{"type":"string","enum":["debit","credit"],"description":"Indicates whether the line item is a debit or credit.","example":"debit","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].entry_type","typeLabel":"enum\u003cstring>"},"product_id":{"oneOf":[{"type":"string","description":"Product ID related to the invoice line item.","example":"itm_KbLcWt2qm5p1S2","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Product ID related to the invoice line item.","example":"itm_KbLcWt2qm5p1S2","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].product_id","typeLabel":"string | null"},"price_configuration_id":{"oneOf":[{"type":"string","description":"Catalog price configuration linked to this line. Determines the product and revenue classification when subscription terms cannot be resolved. Must belong to the supplied product, if any. On finalized invoices, changing this link never changes amounts or taxes.","example":"pcf_monthly","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].price_configuration_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Catalog price configuration linked to this line. Determines the product and revenue classification when subscription terms cannot be resolved. Must belong to the supplied product, if any. On finalized invoices, changing this link never changes amounts or taxes.","example":"pcf_monthly","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].price_configuration_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].price_configuration_id","typeLabel":"string | null"},"product_type":{"oneOf":[{"type":"string","enum":["flat_fee","seat","dynamic","credit","bundle"],"description":"Product type related to the invoice line item.","example":"flat_fee","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].product_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["flat_fee","seat","dynamic","credit","bundle"],"description":"Product type related to the invoice line item.","example":"flat_fee","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].product_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].product_type","typeLabel":"enum\u003cstring> | null"},"units_count":{"type":"number","description":"Count of units of the product related to the invoice line item.","example":1,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].units_count","typeLabel":"number"},"unit_amount":{"type":"number","description":"Amount of one unit of the product related to the invoice line item. Expressed in currency's smallest unit.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].unit_amount","typeLabel":"number"},"amount":{"type":"number","description":"Total amount of the invoice line item. Debit or credit can be distinguished using the `entry_type` field. Expressed in currency's smallest unit.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].amount","typeLabel":"number"},"amount_excluding_tax":{"type":"number","description":"Total amount without the taxes amount of the invoice line item. Expressed in currency's smallest unit.","example":20000,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].amount_excluding_tax","typeLabel":"number"},"tax_rate":{"type":"number","description":"Tax rate of the invoice line item.","example":20,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].tax_rate","typeLabel":"number"},"tax_rate_id":{"oneOf":[{"type":"string","description":"Custom tax rate ID applied to the invoice line item.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].tax_rate_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom tax rate ID applied to the invoice line item.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].tax_rate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].tax_rate_id","typeLabel":"string | null"},"tax_amount":{"type":"number","description":"Tax amount of the invoice line item. Expressed in currency's smallest unit.","example":4000,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].tax_amount","typeLabel":"number"},"discount_amount":{"type":"number","description":"Amount corresponding to the discounted part of the total amount of the invoice line item. Expressed in currency's smallest unit.","example":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].discount_amount","typeLabel":"number"},"discount_percent":{"oneOf":[{"type":"number","description":"Percentage applied to compute the discounted part of the invoice line amount. Only if coupons applied are percentage based.","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","description":"Percentage applied to compute the discounted part of the invoice line amount. Only if coupons applied are percentage based.","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].discount_percent","typeLabel":"number | null"},"period_starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the line item's service period.","example":"2026-10-13T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].period_starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date of the line item's service period.","example":"2026-10-13T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].period_starts_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].period_starts_at","typeLabel":"string\u003cdate-time> | null"},"period_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the line item's service period.","example":"2026-11-13T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].period_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the line item's service period.","example":"2026-11-13T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].period_ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].period_ends_at","typeLabel":"string\u003cdate-time> | null"},"revenue_type":{"oneOf":[{"type":"string","enum":["recurring","variable","one_off"],"description":"Revenue type classification of the line item.\n\n- `recurring`: Recurring revenue (MRR) from subscription products billed at regular intervals.\n- `variable`: Variable revenue from usage-based products.\n- `one_off`: One-time revenue from single charges or products billed once.","example":"recurring","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].revenue_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["recurring","variable","one_off"],"description":"Revenue type classification of the line item.\n\n- `recurring`: Recurring revenue (MRR) from subscription products billed at regular intervals.\n- `variable`: Variable revenue from usage-based products.\n- `one_off`: One-time revenue from single charges or products billed once.","example":"recurring","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].revenue_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].revenue_type","typeLabel":"enum\u003cstring> | null"},"revenue_interval_count":{"oneOf":[{"type":"number","description":"Number of billing interval periods for recurring or variable revenue (e.g., 1 with months for monthly, 1 with years for annual). This is separate from the line service dates.","example":1,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].revenue_interval_count.oneOf.0","typeLabel":"number"},{"type":"null","description":"Number of billing interval periods for recurring or variable revenue (e.g., 1 with months for monthly, 1 with years for annual). This is separate from the line service dates.","example":1,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].revenue_interval_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].revenue_interval_count","typeLabel":"number | null"},"revenue_interval_period":{"oneOf":[{"type":"string","enum":["days","weeks","months","quarters","years","once","all"],"description":"Billing interval unit for recurring or variable revenue (days, weeks, months, quarters, years). One-off revenue has no billing interval.","example":"months","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].revenue_interval_period.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["days","weeks","months","quarters","years","once","all"],"description":"Billing interval unit for recurring or variable revenue (days, weeks, months, quarters, years). One-off revenue has no billing interval.","example":"months","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].revenue_interval_period.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].revenue_interval_period","typeLabel":"enum\u003cstring> | null"},"display_unit_amount":{"type":"boolean","description":"Whether the unit amount is displayed on the invoice PDF. Defaults to true.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].display_unit_amount","typeLabel":"boolean"},"display_service_period":{"type":"boolean","description":"Whether the service period dates are displayed in the line item description on the invoice PDF. Defaults to true.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].display_service_period","typeLabel":"boolean"},"subscription_id":{"oneOf":[{"type":"string","description":"ID of the subscription billed by this line. For consolidated lines, this is the subscription of the source invoice. Null for lines without a subscription.","example":"sub_amiaWZ3lzDIWaoT","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the subscription billed by this line. For consolidated lines, this is the subscription of the source invoice. Null for lines without a subscription.","example":"sub_amiaWZ3lzDIWaoT","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].subscription_id","typeLabel":"string | null"},"original_line_item_id":{"oneOf":[{"type":"string","description":"ID of the original line item this line item is linked to (used for organisation-based billing).","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].original_line_item_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the original line item this line item is linked to (used for organisation-based billing).","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].original_line_item_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX].original_line_item_id","typeLabel":"string | null"}},"required":["id","name","entry_type","product_id","price_configuration_id","product_type","units_count","unit_amount","amount","amount_excluding_tax","tax_rate","tax_rate_id","tax_amount","discount_amount","discount_percent","period_starts_at","period_ends_at","revenue_type","revenue_interval_count","revenue_interval_period","display_unit_amount","display_service_period","subscription_id","original_line_item_id"],"uniqueKey":"data.items.[INDEX].line_items.items.[INDEX]","typeLabel":"object"},"description":"List of line items composing the invoice.","isRequired":true,"uniqueKey":"data.items.[INDEX].line_items","typeLabel":"object[]"},"coupons":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Coupon ID.","example":"cou_DKL4Xcb5VSa8CQ","isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Coupon ID.","example":"cou_DKL4Xcb5VSa8CQ","isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Coupon name.","example":"Partner discount","isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Coupon name.","example":"Partner discount","isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].name","typeLabel":"string | null"},"subscription_coupon_id":{"oneOf":[{"type":"string","description":"ID of the subscription coupon the discount comes from, matching `subscription_coupon_id` on the subscription coupons. Null when the coupon was added directly to the invoice.","example":"coos_d9pVekhjoGppuX","isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].subscription_coupon_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the subscription coupon the discount comes from, matching `subscription_coupon_id` on the subscription coupons. Null when the coupon was added directly to the invoice.","example":"coos_d9pVekhjoGppuX","isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].subscription_coupon_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].subscription_coupon_id","typeLabel":"string | null"},"discount_amount":{"oneOf":[{"type":"number","description":"Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.","example":2000,"isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].discount_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.","example":2000,"isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].discount_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].discount_amount","typeLabel":"number | null"},"discount_percent":{"oneOf":[{"type":"number","description":"Percentage to apply as a discount on the amount (excluding taxes) of a product.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","description":"Percentage to apply as a discount on the amount (excluding taxes) of a product.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].discount_percent","typeLabel":"number | null"},"line_item_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].line_item_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"IDs of the line items to which the coupon applies. Null means all line items.","example":["ili_0FACNpeoEFkGu3"],"isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].line_item_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"IDs of the line items to which the coupon applies. Null means all line items.","example":["ili_0FACNpeoEFkGu3"],"isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].line_item_ids.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX].line_item_ids","typeLabel":"string[] | null"}},"required":["id","name","subscription_coupon_id","discount_amount","discount_percent","line_item_ids"],"uniqueKey":"data.items.[INDEX].coupons.items.[INDEX]","typeLabel":"object"},"description":"List of coupons applied to the invoice.","isRequired":true,"uniqueKey":"data.items.[INDEX].coupons","typeLabel":"object[]"},"transactions":{"type":"array","items":{"oneOf":[{"type":"object","title":"Transaction Card/debit","required":["status","payment_method_type","payment_method","id","type","amount","currency","customer_id","provider_id","process_at","settled_at","created_at","updated_at","refunded_at","original_transaction_id","reversed_at","last_refreshed_at","provider_fee","chargeback","integrations"],"properties":{"id":{"type":"string","description":"Transaction ID.","example":"tra_2QdJDDUej969ev","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.id","typeLabel":"string"},"type":{"type":"string","enum":["subscription","one_time","refund","chargeback"],"description":"\nTransaction type.\n\n- `subscription`: The transaction is related to a subscription payment.\n- `one_time`: The transaction is related to a one-time payment.\n- `refund`: The transaction is related to a refund payment.\n- `chargeback`: The transaction records funds withdrawn after a payment dispute.\n ","example":"subscription","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Transaction amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Transaction currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.currency","typeLabel":"enum\u003cstring>"},"customer_id":{"type":"string","description":"ID of the customer linked to the transaction.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.customer_id","typeLabel":"string"},"provider_id":{"oneOf":[{"type":"string","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.provider_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.provider_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.provider_id","typeLabel":"string | null"},"process_at":{"type":"string","format":"date-time","description":"Date corresponding to the processing of the transaction. If in the future, the transaction is scheduled to be processed.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.process_at","typeLabel":"string\u003cdate-time>"},"settled_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.settled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.settled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.settled_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","description":"Date the transaction was recorded in Hyperline, independent of its processing date.","example":"2026-11-12T10:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date the transaction or its invoice allocations were last updated in Hyperline. Use the updated_at filters to sync changes incrementally.","example":"2026-11-12T11:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"refunded_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.refunded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.refunded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.refunded_at","typeLabel":"string\u003cdate-time> | null"},"original_transaction_id":{"oneOf":[{"type":"string","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.original_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.original_transaction_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.original_transaction_id","typeLabel":"string | null"},"reversed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.reversed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.reversed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.reversed_at","typeLabel":"string\u003cdate-time> | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"provider_fee":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.provider_fee.oneOf.0.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.provider_fee.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"exchange_rate":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.provider_fee.oneOf.0.exchange_rate.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.provider_fee.oneOf.0.exchange_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.provider_fee.oneOf.0.exchange_rate","typeLabel":"number | null"}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.provider_fee.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit."},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR"},"exchange_rate":{"oneOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.provider_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.provider_fee","typeLabel":"object | null"},"chargeback":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.chargeback.oneOf.0.amount","typeLabel":"number"},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.chargeback.oneOf.0.last_chargeback_at","typeLabel":"string\u003cdate-time>"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.chargeback.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.chargeback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.chargeback","typeLabel":"object | null"},"integrations":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.integrations.items.[INDEX].entity_id","typeLabel":"string"},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","paypal","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.integrations.items.[INDEX].provider_name","typeLabel":"enum\u003cstring>"},"provider_account_id":{"type":"string","description":"ID of the connected provider account.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.integrations.items.[INDEX].provider_account_id","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.integrations.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.integrations.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.integrations.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.integrations.items.[INDEX].activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.integrations.items.[INDEX].activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.integrations.items.[INDEX].activated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["entity_id","provider_name","provider_account_id"],"description":"Reference to the entity in an external provider.","example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.integrations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.integrations","typeLabel":"object[]"},"payment_method_type":{"type":"string","enum":["card","direct_debit","direct_debit_ach","direct_debit_bacs"],"description":"Payment method type used for the transaction.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method_type","typeLabel":"enum\u003cstring>"},"payment_method":{"oneOf":[{"type":"object","title":"Card","description":"Payment method used for a card or direct debit transaction.","required":["id","status","type","last_4_digits","expiration_date","brand"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0.id","typeLabel":"string"},"status":{"type":"string","enum":["active","pending","expired","errored"],"description":"\nPayment method status.\n\n- `active`: The payment method is ready to be used.\n- `pending`: The payment method is pending activation or being validated.\n ","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0.status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["card","apple_pay","google_pay"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"card","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0.type","typeLabel":"enum\u003cstring>"},"last_4_digits":{"oneOf":[{"type":"number","description":"Last four digits of the card.","example":2718,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0.last_4_digits.oneOf.0","typeLabel":"number"},{"type":"null","description":"Last four digits of the card.","example":2718,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0.last_4_digits.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0.last_4_digits","typeLabel":"number | null"},"expiration_date":{"oneOf":[{"type":"string","description":"Expiration date of the card using YYYY-MM format.","example":"2027-11","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0.expiration_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expiration date of the card using YYYY-MM format.","example":"2027-11","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0.expiration_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0.expiration_date","typeLabel":"string | null"},"brand":{"oneOf":[{"type":"string","enum":["amex","bancontact","cartes_bancaires","diners","discover","jcb","link","maestro","mastercard","other","unionpay","unknown","visa"],"description":"Card brand.","examples":["visa","mastercard","amex"],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0.brand.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["amex","bancontact","cartes_bancaires","diners","discover","jcb","link","maestro","mastercard","other","unionpay","unknown","visa"],"description":"Card brand.","examples":["visa","mastercard","amex"],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0.brand.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0.brand","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.0","typeLabel":"Card · object"},{"type":"object","title":"Card (errored)","description":"Payment method used for a card or direct debit transaction.","required":["id","status","error_type","type","last_4_digits","expiration_date","brand"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.id","typeLabel":"string"},"status":{"type":"string","enum":["errored"],"description":"\nPayment method status.\n\n- `errored`: The payment method has failed and can no longer be used.\n ","example":"errored","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.status","typeLabel":"enum\u003cstring>"},"error_type":{"type":"string","enum":["authentication_required","authorization_error","insufficient_funds","declined","expired","fraud","invalid","mandate_invalid","not_supported","unknown"],"description":"\nPayment method error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `unknown`: A generic error happened on the payment provider side.\n ","example":"expired","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.error_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["card","apple_pay","google_pay"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"card","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.type","typeLabel":"enum\u003cstring>"},"last_4_digits":{"oneOf":[{"type":"number","description":"Last four digits of the card.","example":2718,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.last_4_digits.oneOf.0","typeLabel":"number"},{"type":"null","description":"Last four digits of the card.","example":2718,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.last_4_digits.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.last_4_digits","typeLabel":"number | null"},"expiration_date":{"oneOf":[{"type":"string","description":"Expiration date of the card using YYYY-MM format.","example":"2027-11","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.expiration_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expiration date of the card using YYYY-MM format.","example":"2027-11","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.expiration_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.expiration_date","typeLabel":"string | null"},"brand":{"oneOf":[{"type":"string","enum":["amex","bancontact","cartes_bancaires","diners","discover","jcb","link","maestro","mastercard","other","unionpay","unknown","visa"],"description":"Card brand.","examples":["visa","mastercard","amex"],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.brand.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["amex","bancontact","cartes_bancaires","diners","discover","jcb","link","maestro","mastercard","other","unionpay","unknown","visa"],"description":"Card brand.","examples":["visa","mastercard","amex"],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.brand.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1.brand","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.1","typeLabel":"Card (errored) · object"},{"type":"object","title":"Direct Debit","description":"Payment method used for a card or direct debit transaction.","required":["id","status","type","account_number_ending"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.2.id","typeLabel":"string"},"status":{"type":"string","enum":["active","pending","expired","errored"],"description":"\nPayment method status.\n\n- `active`: The payment method is ready to be used.\n- `pending`: The payment method is pending activation or being validated.\n ","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.2.status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["direct_debit","direct_debit_ach","direct_debit_bacs"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"direct_debit","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.2.type","typeLabel":"enum\u003cstring>"},"account_number_ending":{"oneOf":[{"type":"string","description":"Last characters of the account number.","example":"6789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.2.account_number_ending.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last characters of the account number.","example":"6789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.2.account_number_ending.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.2.account_number_ending","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.2","typeLabel":"Direct Debit · object"},{"type":"object","title":"Direct Debit (errored)","description":"Payment method used for a card or direct debit transaction.","required":["id","status","error_type","type","account_number_ending"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.3.id","typeLabel":"string"},"status":{"type":"string","enum":["errored"],"description":"\nPayment method status.\n\n- `errored`: The payment method has failed and can no longer be used.\n ","example":"errored","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.3.status","typeLabel":"enum\u003cstring>"},"error_type":{"type":"string","enum":["authentication_required","authorization_error","insufficient_funds","declined","expired","fraud","invalid","mandate_invalid","not_supported","unknown"],"description":"\nPayment method error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `unknown`: A generic error happened on the payment provider side.\n ","example":"expired","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.3.error_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["direct_debit","direct_debit_ach","direct_debit_bacs"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"direct_debit","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.3.type","typeLabel":"enum\u003cstring>"},"account_number_ending":{"oneOf":[{"type":"string","description":"Last characters of the account number.","example":"6789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.3.account_number_ending.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last characters of the account number.","example":"6789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.3.account_number_ending.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.3.account_number_ending","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.3","typeLabel":"Direct Debit (errored) · object"},{"type":"object","title":"Stripe Link","description":"Payment method used for a card or direct debit transaction.","required":["id","status","type"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.4.id","typeLabel":"string"},"status":{"type":"string","enum":["active","pending","expired","errored"],"description":"\nPayment method status.\n\n- `active`: The payment method is ready to be used.\n- `pending`: The payment method is pending activation or being validated.\n ","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.4.status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["stripe_link"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"stripe_link","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.4.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.4","typeLabel":"Stripe Link · object"},{"type":"object","title":"Stripe Link (errored)","description":"Payment method used for a card or direct debit transaction.","required":["id","status","error_type","type"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.5.id","typeLabel":"string"},"status":{"type":"string","enum":["errored"],"description":"\nPayment method status.\n\n- `errored`: The payment method has failed and can no longer be used.\n ","example":"errored","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.5.status","typeLabel":"enum\u003cstring>"},"error_type":{"type":"string","enum":["authentication_required","authorization_error","insufficient_funds","declined","expired","fraud","invalid","mandate_invalid","not_supported","unknown"],"description":"\nPayment method error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `unknown`: A generic error happened on the payment provider side.\n ","example":"expired","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.5.error_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["stripe_link"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"stripe_link","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.5.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.5","typeLabel":"Stripe Link (errored) · object"},{"type":"object","title":"PayPal","description":"Payment method used for a card or direct debit transaction.","required":["id","status","type"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.6.id","typeLabel":"string"},"status":{"type":"string","enum":["active","pending","expired","errored"],"description":"\nPayment method status.\n\n- `active`: The payment method is ready to be used.\n- `pending`: The payment method is pending activation or being validated.\n ","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.6.status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["paypal"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"paypal","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.6.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.6","typeLabel":"PayPal · object"},{"type":"object","title":"PayPal (errored)","description":"Payment method used for a card or direct debit transaction.","required":["id","status","error_type","type"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.7.id","typeLabel":"string"},"status":{"type":"string","enum":["errored"],"description":"\nPayment method status.\n\n- `errored`: The payment method has failed and can no longer be used.\n ","example":"errored","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.7.status","typeLabel":"enum\u003cstring>"},"error_type":{"type":"string","enum":["authentication_required","authorization_error","insufficient_funds","declined","expired","fraud","invalid","mandate_invalid","not_supported","unknown"],"description":"\nPayment method error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `unknown`: A generic error happened on the payment provider side.\n ","example":"expired","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.7.error_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["paypal"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"paypal","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.7.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.7","typeLabel":"PayPal (errored) · object"},{"type":"null","description":"Payment method used for a card or direct debit transaction.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method.oneOf.8","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.payment_method","typeLabel":"Card · object | Card (errored) · object | Direct Debit · object | Direct Debit (errored) · object | Stripe Link · object | Stripe Link (errored) · object | PayPal · object | PayPal (errored) · object | null"},"status":{"type":"string","enum":["scheduled","to_process","pending","settled","cancelled"],"description":"\nTransaction status.\n\n- `scheduled`: The transaction is scheduled to be processed in the future.\n- `to_process`: The transaction is waiting to be processed by our system.\n- `pending`: The transaction has been authorized by the related payment processor, but the banking transaction is not yet settled.\n- `settled`: The transaction has been cleared on the banking side, the money transfer is fully completed.\n- `cancelled`: The transaction has been cancelled and won't be processed again.\n ","example":"settled","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.0","typeLabel":"Transaction Card/debit · object"},{"type":"object","title":"Transaction Card/debit failed","required":["status","error_type","error_message","payment_method_type","payment_method","id","type","amount","currency","customer_id","provider_id","process_at","settled_at","created_at","updated_at","refunded_at","original_transaction_id","reversed_at","last_refreshed_at","provider_fee","chargeback","integrations"],"properties":{"id":{"type":"string","description":"Transaction ID.","example":"tra_2QdJDDUej969ev","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.id","typeLabel":"string"},"type":{"type":"string","enum":["subscription","one_time","refund","chargeback"],"description":"\nTransaction type.\n\n- `subscription`: The transaction is related to a subscription payment.\n- `one_time`: The transaction is related to a one-time payment.\n- `refund`: The transaction is related to a refund payment.\n- `chargeback`: The transaction records funds withdrawn after a payment dispute.\n ","example":"subscription","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Transaction amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Transaction currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.currency","typeLabel":"enum\u003cstring>"},"customer_id":{"type":"string","description":"ID of the customer linked to the transaction.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.customer_id","typeLabel":"string"},"provider_id":{"oneOf":[{"type":"string","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.provider_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.provider_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.provider_id","typeLabel":"string | null"},"process_at":{"type":"string","format":"date-time","description":"Date corresponding to the processing of the transaction. If in the future, the transaction is scheduled to be processed.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.process_at","typeLabel":"string\u003cdate-time>"},"settled_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.settled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.settled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.settled_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","description":"Date the transaction was recorded in Hyperline, independent of its processing date.","example":"2026-11-12T10:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date the transaction or its invoice allocations were last updated in Hyperline. Use the updated_at filters to sync changes incrementally.","example":"2026-11-12T11:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.updated_at","typeLabel":"string\u003cdate-time>"},"refunded_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.refunded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.refunded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.refunded_at","typeLabel":"string\u003cdate-time> | null"},"original_transaction_id":{"oneOf":[{"type":"string","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.original_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.original_transaction_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.original_transaction_id","typeLabel":"string | null"},"reversed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.reversed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.reversed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.reversed_at","typeLabel":"string\u003cdate-time> | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"provider_fee":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.provider_fee.oneOf.0.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.provider_fee.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"exchange_rate":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.provider_fee.oneOf.0.exchange_rate.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.provider_fee.oneOf.0.exchange_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.provider_fee.oneOf.0.exchange_rate","typeLabel":"number | null"}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.provider_fee.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit."},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR"},"exchange_rate":{"oneOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.provider_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.provider_fee","typeLabel":"object | null"},"chargeback":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.chargeback.oneOf.0.amount","typeLabel":"number"},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.chargeback.oneOf.0.last_chargeback_at","typeLabel":"string\u003cdate-time>"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.chargeback.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.chargeback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.chargeback","typeLabel":"object | null"},"integrations":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.integrations.items.[INDEX].entity_id","typeLabel":"string"},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","paypal","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.integrations.items.[INDEX].provider_name","typeLabel":"enum\u003cstring>"},"provider_account_id":{"type":"string","description":"ID of the connected provider account.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.integrations.items.[INDEX].provider_account_id","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.integrations.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.integrations.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.integrations.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.integrations.items.[INDEX].activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.integrations.items.[INDEX].activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.integrations.items.[INDEX].activated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["entity_id","provider_name","provider_account_id"],"description":"Reference to the entity in an external provider.","example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.integrations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.integrations","typeLabel":"object[]"},"payment_method_type":{"type":"string","enum":["card","direct_debit","direct_debit_ach","direct_debit_bacs"],"description":"Payment method type used for the transaction.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method_type","typeLabel":"enum\u003cstring>"},"payment_method":{"oneOf":[{"type":"object","title":"Card","description":"Payment method used for a card or direct debit transaction.","required":["id","status","type","last_4_digits","expiration_date","brand"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0.id","typeLabel":"string"},"status":{"type":"string","enum":["active","pending","expired","errored"],"description":"\nPayment method status.\n\n- `active`: The payment method is ready to be used.\n- `pending`: The payment method is pending activation or being validated.\n ","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0.status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["card","apple_pay","google_pay"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"card","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0.type","typeLabel":"enum\u003cstring>"},"last_4_digits":{"oneOf":[{"type":"number","description":"Last four digits of the card.","example":2718,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0.last_4_digits.oneOf.0","typeLabel":"number"},{"type":"null","description":"Last four digits of the card.","example":2718,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0.last_4_digits.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0.last_4_digits","typeLabel":"number | null"},"expiration_date":{"oneOf":[{"type":"string","description":"Expiration date of the card using YYYY-MM format.","example":"2027-11","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0.expiration_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expiration date of the card using YYYY-MM format.","example":"2027-11","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0.expiration_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0.expiration_date","typeLabel":"string | null"},"brand":{"oneOf":[{"type":"string","enum":["amex","bancontact","cartes_bancaires","diners","discover","jcb","link","maestro","mastercard","other","unionpay","unknown","visa"],"description":"Card brand.","examples":["visa","mastercard","amex"],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0.brand.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["amex","bancontact","cartes_bancaires","diners","discover","jcb","link","maestro","mastercard","other","unionpay","unknown","visa"],"description":"Card brand.","examples":["visa","mastercard","amex"],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0.brand.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0.brand","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.0","typeLabel":"Card · object"},{"type":"object","title":"Card (errored)","description":"Payment method used for a card or direct debit transaction.","required":["id","status","error_type","type","last_4_digits","expiration_date","brand"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.id","typeLabel":"string"},"status":{"type":"string","enum":["errored"],"description":"\nPayment method status.\n\n- `errored`: The payment method has failed and can no longer be used.\n ","example":"errored","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.status","typeLabel":"enum\u003cstring>"},"error_type":{"type":"string","enum":["authentication_required","authorization_error","insufficient_funds","declined","expired","fraud","invalid","mandate_invalid","not_supported","unknown"],"description":"\nPayment method error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `unknown`: A generic error happened on the payment provider side.\n ","example":"expired","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.error_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["card","apple_pay","google_pay"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"card","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.type","typeLabel":"enum\u003cstring>"},"last_4_digits":{"oneOf":[{"type":"number","description":"Last four digits of the card.","example":2718,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.last_4_digits.oneOf.0","typeLabel":"number"},{"type":"null","description":"Last four digits of the card.","example":2718,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.last_4_digits.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.last_4_digits","typeLabel":"number | null"},"expiration_date":{"oneOf":[{"type":"string","description":"Expiration date of the card using YYYY-MM format.","example":"2027-11","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.expiration_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Expiration date of the card using YYYY-MM format.","example":"2027-11","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.expiration_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.expiration_date","typeLabel":"string | null"},"brand":{"oneOf":[{"type":"string","enum":["amex","bancontact","cartes_bancaires","diners","discover","jcb","link","maestro","mastercard","other","unionpay","unknown","visa"],"description":"Card brand.","examples":["visa","mastercard","amex"],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.brand.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["amex","bancontact","cartes_bancaires","diners","discover","jcb","link","maestro","mastercard","other","unionpay","unknown","visa"],"description":"Card brand.","examples":["visa","mastercard","amex"],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.brand.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1.brand","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.1","typeLabel":"Card (errored) · object"},{"type":"object","title":"Direct Debit","description":"Payment method used for a card or direct debit transaction.","required":["id","status","type","account_number_ending"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.2.id","typeLabel":"string"},"status":{"type":"string","enum":["active","pending","expired","errored"],"description":"\nPayment method status.\n\n- `active`: The payment method is ready to be used.\n- `pending`: The payment method is pending activation or being validated.\n ","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.2.status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["direct_debit","direct_debit_ach","direct_debit_bacs"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"direct_debit","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.2.type","typeLabel":"enum\u003cstring>"},"account_number_ending":{"oneOf":[{"type":"string","description":"Last characters of the account number.","example":"6789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.2.account_number_ending.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last characters of the account number.","example":"6789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.2.account_number_ending.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.2.account_number_ending","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.2","typeLabel":"Direct Debit · object"},{"type":"object","title":"Direct Debit (errored)","description":"Payment method used for a card or direct debit transaction.","required":["id","status","error_type","type","account_number_ending"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.3.id","typeLabel":"string"},"status":{"type":"string","enum":["errored"],"description":"\nPayment method status.\n\n- `errored`: The payment method has failed and can no longer be used.\n ","example":"errored","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.3.status","typeLabel":"enum\u003cstring>"},"error_type":{"type":"string","enum":["authentication_required","authorization_error","insufficient_funds","declined","expired","fraud","invalid","mandate_invalid","not_supported","unknown"],"description":"\nPayment method error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `unknown`: A generic error happened on the payment provider side.\n ","example":"expired","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.3.error_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["direct_debit","direct_debit_ach","direct_debit_bacs"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"direct_debit","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.3.type","typeLabel":"enum\u003cstring>"},"account_number_ending":{"oneOf":[{"type":"string","description":"Last characters of the account number.","example":"6789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.3.account_number_ending.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last characters of the account number.","example":"6789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.3.account_number_ending.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.3.account_number_ending","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.3","typeLabel":"Direct Debit (errored) · object"},{"type":"object","title":"Stripe Link","description":"Payment method used for a card or direct debit transaction.","required":["id","status","type"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.4.id","typeLabel":"string"},"status":{"type":"string","enum":["active","pending","expired","errored"],"description":"\nPayment method status.\n\n- `active`: The payment method is ready to be used.\n- `pending`: The payment method is pending activation or being validated.\n ","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.4.status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["stripe_link"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"stripe_link","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.4.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.4","typeLabel":"Stripe Link · object"},{"type":"object","title":"Stripe Link (errored)","description":"Payment method used for a card or direct debit transaction.","required":["id","status","error_type","type"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.5.id","typeLabel":"string"},"status":{"type":"string","enum":["errored"],"description":"\nPayment method status.\n\n- `errored`: The payment method has failed and can no longer be used.\n ","example":"errored","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.5.status","typeLabel":"enum\u003cstring>"},"error_type":{"type":"string","enum":["authentication_required","authorization_error","insufficient_funds","declined","expired","fraud","invalid","mandate_invalid","not_supported","unknown"],"description":"\nPayment method error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `unknown`: A generic error happened on the payment provider side.\n ","example":"expired","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.5.error_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["stripe_link"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"stripe_link","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.5.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.5","typeLabel":"Stripe Link (errored) · object"},{"type":"object","title":"PayPal","description":"Payment method used for a card or direct debit transaction.","required":["id","status","type"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.6.id","typeLabel":"string"},"status":{"type":"string","enum":["active","pending","expired","errored"],"description":"\nPayment method status.\n\n- `active`: The payment method is ready to be used.\n- `pending`: The payment method is pending activation or being validated.\n ","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.6.status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["paypal"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"paypal","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.6.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.6","typeLabel":"PayPal · object"},{"type":"object","title":"PayPal (errored)","description":"Payment method used for a card or direct debit transaction.","required":["id","status","error_type","type"],"properties":{"id":{"type":"string","description":"Payment method ID.","example":"pm_1xMpj5bwRqN7LM","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.7.id","typeLabel":"string"},"status":{"type":"string","enum":["errored"],"description":"\nPayment method status.\n\n- `errored`: The payment method has failed and can no longer be used.\n ","example":"errored","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.7.status","typeLabel":"enum\u003cstring>"},"error_type":{"type":"string","enum":["authentication_required","authorization_error","insufficient_funds","declined","expired","fraud","invalid","mandate_invalid","not_supported","unknown"],"description":"\nPayment method error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `unknown`: A generic error happened on the payment provider side.\n ","example":"expired","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.7.error_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["paypal"],"description":"\nPayment method type.\n\n- `card`: Credit or debit card\n- `apple_pay`: Apple Pay\n- `google_pay`: Google Pay\n- `direct_debit_sepa`: SEPA Direct Debit\n- `direct_debit_ach`: ACH Direct Debit\n- `direct_debit_bacs`: Bacs Direct Debit\n- `stripe_link`: Stripe Link\n- `paypal`: PayPal\n ","example":"paypal","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.7.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.7","typeLabel":"PayPal (errored) · object"},{"type":"null","description":"Payment method used for a card or direct debit transaction.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method.oneOf.8","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.payment_method","typeLabel":"Card · object | Card (errored) · object | Direct Debit · object | Direct Debit (errored) · object | Stripe Link · object | Stripe Link (errored) · object | PayPal · object | PayPal (errored) · object | null"},"status":{"type":"string","enum":["failed"],"description":"\nTransaction status.\n\n- `failed`: The transaction failed.\n ","example":"failed","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"},"error_type":{"oneOf":[{"type":"string","enum":["authentication_required","declined","fraud","insufficient_funds","mandate_invalid","payment_method_authorization_error","payment_method_declined","payment_method_expired","payment_method_invalid","payment_method_not_supported","processing_error","provider_error","unknown"],"description":"\nTransaction error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `payment_method_authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `payment_method_declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `payment_method_expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `payment_method_invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `payment_method_not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `declined`: The payment was declined for a variety of reasons such as security violation, banking service not available, transaction not allowed, etc.\n- `fraud`: The payment provider suspected the transaction was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `processing_error`: The payment couldn't be processed by the issuer for an unknown reason.\n- `provider_error`: An error occurred when contacting the payment provider to initiate the transaction.\n- `unknown`: A generic error happened on the payment provider side.\n ","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.error_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["authentication_required","declined","fraud","insufficient_funds","mandate_invalid","payment_method_authorization_error","payment_method_declined","payment_method_expired","payment_method_invalid","payment_method_not_supported","processing_error","provider_error","unknown"],"description":"\nTransaction error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `payment_method_authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `payment_method_declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `payment_method_expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `payment_method_invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `payment_method_not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `declined`: The payment was declined for a variety of reasons such as security violation, banking service not available, transaction not allowed, etc.\n- `fraud`: The payment provider suspected the transaction was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `processing_error`: The payment couldn't be processed by the issuer for an unknown reason.\n- `provider_error`: An error occurred when contacting the payment provider to initiate the transaction.\n- `unknown`: A generic error happened on the payment provider side.\n ","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.error_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.error_type","typeLabel":"enum\u003cstring> | null"},"error_message":{"oneOf":[{"type":"string","description":"Details of the error.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.error_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Details of the error.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.error_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1.error_message","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.1","typeLabel":"Transaction Card/debit failed · object"},{"type":"object","title":"Transaction Transfer","required":["status","payment_method_type","bank_account","id","type","amount","currency","customer_id","provider_id","process_at","settled_at","created_at","updated_at","refunded_at","original_transaction_id","reversed_at","last_refreshed_at","provider_fee","chargeback","integrations"],"properties":{"id":{"type":"string","description":"Transaction ID.","example":"tra_2QdJDDUej969ev","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.id","typeLabel":"string"},"type":{"type":"string","enum":["subscription","one_time","refund","chargeback"],"description":"\nTransaction type.\n\n- `subscription`: The transaction is related to a subscription payment.\n- `one_time`: The transaction is related to a one-time payment.\n- `refund`: The transaction is related to a refund payment.\n- `chargeback`: The transaction records funds withdrawn after a payment dispute.\n ","example":"subscription","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Transaction amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Transaction currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.currency","typeLabel":"enum\u003cstring>"},"customer_id":{"type":"string","description":"ID of the customer linked to the transaction.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.customer_id","typeLabel":"string"},"provider_id":{"oneOf":[{"type":"string","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.provider_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.provider_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.provider_id","typeLabel":"string | null"},"process_at":{"type":"string","format":"date-time","description":"Date corresponding to the processing of the transaction. If in the future, the transaction is scheduled to be processed.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.process_at","typeLabel":"string\u003cdate-time>"},"settled_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.settled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.settled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.settled_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","description":"Date the transaction was recorded in Hyperline, independent of its processing date.","example":"2026-11-12T10:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date the transaction or its invoice allocations were last updated in Hyperline. Use the updated_at filters to sync changes incrementally.","example":"2026-11-12T11:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.updated_at","typeLabel":"string\u003cdate-time>"},"refunded_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.refunded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.refunded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.refunded_at","typeLabel":"string\u003cdate-time> | null"},"original_transaction_id":{"oneOf":[{"type":"string","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.original_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.original_transaction_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.original_transaction_id","typeLabel":"string | null"},"reversed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.reversed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.reversed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.reversed_at","typeLabel":"string\u003cdate-time> | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"provider_fee":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.provider_fee.oneOf.0.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.provider_fee.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"exchange_rate":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.provider_fee.oneOf.0.exchange_rate.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.provider_fee.oneOf.0.exchange_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.provider_fee.oneOf.0.exchange_rate","typeLabel":"number | null"}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.provider_fee.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit."},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR"},"exchange_rate":{"oneOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.provider_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.provider_fee","typeLabel":"object | null"},"chargeback":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.chargeback.oneOf.0.amount","typeLabel":"number"},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.chargeback.oneOf.0.last_chargeback_at","typeLabel":"string\u003cdate-time>"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.chargeback.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.chargeback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.chargeback","typeLabel":"object | null"},"integrations":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.integrations.items.[INDEX].entity_id","typeLabel":"string"},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","paypal","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.integrations.items.[INDEX].provider_name","typeLabel":"enum\u003cstring>"},"provider_account_id":{"type":"string","description":"ID of the connected provider account.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.integrations.items.[INDEX].provider_account_id","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.integrations.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.integrations.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.integrations.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.integrations.items.[INDEX].activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.integrations.items.[INDEX].activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.integrations.items.[INDEX].activated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["entity_id","provider_name","provider_account_id"],"description":"Reference to the entity in an external provider.","example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.integrations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.integrations","typeLabel":"object[]"},"payment_method_type":{"type":"string","enum":["transfer","transfer_automated"],"description":"Payment method type used for the transaction.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.payment_method_type","typeLabel":"enum\u003cstring>"},"bank_account":{"oneOf":[{"type":"object","title":"Standard bank account","description":"Bank account used for a bank transfer transaction.","required":["format","iban","bic_swift","id","currency","bank_name","name","country","type"],"example":{"format":"iban_bic_swift","iban":"FR7630006000011234567890189","bic_swift":"BNPAFRPP"},"properties":{"type":{"type":"string","enum":["standard"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"standard","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.country","typeLabel":"string | null"},"format":{"type":"string","enum":["iban_bic_swift"],"description":"Bank account details format.","example":"iban_bic_swift","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.format","typeLabel":"enum\u003cstring>"},"iban":{"type":"string","description":"IBAN.","example":"FR7630006000011234567890189","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.iban","typeLabel":"string"},"bic_swift":{"oneOf":[{"type":"string","description":"BIC or SWIFT code.","example":"BNPAFRPP","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.bic_swift.oneOf.0","typeLabel":"string"},{"type":"null","description":"BIC or SWIFT code.","example":"BNPAFRPP","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.bic_swift.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0.bic_swift","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.0","typeLabel":"Standard bank account · object"},{"type":"object","title":"Standard bank account","description":"Bank account used for a bank transfer transaction.","required":["format","sort_code","account_number","id","currency","bank_name","name","country","type"],"example":{"format":"iban_bic_swift"},"properties":{"type":{"type":"string","enum":["standard"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"standard","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.country","typeLabel":"string | null"},"format":{"type":"string","enum":["sort_code_account_number"],"description":"Bank account details format.","example":"sort_code_account_number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.format","typeLabel":"enum\u003cstring>"},"sort_code":{"type":"string","description":"Sort code.","example":"123456","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.sort_code","typeLabel":"string"},"account_number":{"type":"string","description":"Account number.","example":"000123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1.account_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.1","typeLabel":"Standard bank account · object"},{"type":"object","title":"Standard bank account","description":"Bank account used for a bank transfer transaction.","required":["format","account_number","routing_number","id","currency","bank_name","name","country","type"],"example":{"format":"iban_bic_swift"},"properties":{"type":{"type":"string","enum":["standard"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"standard","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.country","typeLabel":"string | null"},"format":{"type":"string","enum":["account_number_routing_number"],"description":"Bank account details format.","example":"account_number_routing_number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.format","typeLabel":"enum\u003cstring>"},"account_number":{"type":"string","description":"Account number.","example":"000123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.account_number","typeLabel":"string"},"routing_number":{"type":"string","description":"Routing number.","example":"021000021","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2.routing_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.2","typeLabel":"Standard bank account · object"},{"type":"object","title":"Standard bank account","description":"Bank account used for a bank transfer transaction.","required":["format","account_number","bic_swift","id","currency","bank_name","name","country","type"],"example":{"format":"iban_bic_swift","bic_swift":"BNPAFRPP"},"properties":{"type":{"type":"string","enum":["standard"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"standard","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.country","typeLabel":"string | null"},"format":{"type":"string","enum":["account_number_bic_swift"],"description":"Bank account details format.","example":"account_number_bic_swift","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.format","typeLabel":"enum\u003cstring>"},"account_number":{"type":"string","description":"Account number.","example":"000123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.account_number","typeLabel":"string"},"bic_swift":{"type":"string","description":"BIC or SWIFT code.","example":"BNPAFRPP","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3.bic_swift","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.3","typeLabel":"Standard bank account · object"},{"type":"object","title":"Connected bank account","description":"Bank account used for a bank transfer transaction.","required":["format","iban","bic_swift","id","currency","bank_name","name","country","type","status","balance","last_refreshed_at","last_error_type"],"example":{"format":"iban_bic_swift","iban":"FR7630006000011234567890189","bic_swift":"BNPAFRPP"},"properties":{"type":{"type":"string","enum":["connected"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"connected","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["active","error"],"description":"Bank account connection status.","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.status","typeLabel":"enum\u003cstring>"},"balance":{"oneOf":[{"type":"number","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.balance.oneOf.0","typeLabel":"number"},{"type":"null","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.balance","typeLabel":"number | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"last_error_type":{"oneOf":[{"type":"string","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.last_error_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.last_error_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.last_error_type","typeLabel":"enum\u003cstring> | null"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.country","typeLabel":"string | null"},"format":{"type":"string","enum":["iban_bic_swift"],"description":"Bank account details format.","example":"iban_bic_swift","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.format","typeLabel":"enum\u003cstring>"},"iban":{"type":"string","description":"IBAN.","example":"FR7630006000011234567890189","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.iban","typeLabel":"string"},"bic_swift":{"oneOf":[{"type":"string","description":"BIC or SWIFT code.","example":"BNPAFRPP","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.bic_swift.oneOf.0","typeLabel":"string"},{"type":"null","description":"BIC or SWIFT code.","example":"BNPAFRPP","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.bic_swift.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4.bic_swift","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.4","typeLabel":"Connected bank account · object"},{"type":"object","title":"Connected bank account","description":"Bank account used for a bank transfer transaction.","required":["format","sort_code","account_number","id","currency","bank_name","name","country","type","status","balance","last_refreshed_at","last_error_type"],"example":{"format":"iban_bic_swift"},"properties":{"type":{"type":"string","enum":["connected"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"connected","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["active","error"],"description":"Bank account connection status.","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.status","typeLabel":"enum\u003cstring>"},"balance":{"oneOf":[{"type":"number","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.balance.oneOf.0","typeLabel":"number"},{"type":"null","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.balance","typeLabel":"number | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"last_error_type":{"oneOf":[{"type":"string","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.last_error_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.last_error_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.last_error_type","typeLabel":"enum\u003cstring> | null"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.country","typeLabel":"string | null"},"format":{"type":"string","enum":["sort_code_account_number"],"description":"Bank account details format.","example":"sort_code_account_number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.format","typeLabel":"enum\u003cstring>"},"sort_code":{"type":"string","description":"Sort code.","example":"123456","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.sort_code","typeLabel":"string"},"account_number":{"type":"string","description":"Account number.","example":"000123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5.account_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.5","typeLabel":"Connected bank account · object"},{"type":"object","title":"Connected bank account","description":"Bank account used for a bank transfer transaction.","required":["format","account_number","routing_number","id","currency","bank_name","name","country","type","status","balance","last_refreshed_at","last_error_type"],"example":{"format":"iban_bic_swift"},"properties":{"type":{"type":"string","enum":["connected"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"connected","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["active","error"],"description":"Bank account connection status.","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.status","typeLabel":"enum\u003cstring>"},"balance":{"oneOf":[{"type":"number","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.balance.oneOf.0","typeLabel":"number"},{"type":"null","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.balance","typeLabel":"number | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"last_error_type":{"oneOf":[{"type":"string","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.last_error_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.last_error_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.last_error_type","typeLabel":"enum\u003cstring> | null"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.country","typeLabel":"string | null"},"format":{"type":"string","enum":["account_number_routing_number"],"description":"Bank account details format.","example":"account_number_routing_number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.format","typeLabel":"enum\u003cstring>"},"account_number":{"type":"string","description":"Account number.","example":"000123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.account_number","typeLabel":"string"},"routing_number":{"type":"string","description":"Routing number.","example":"021000021","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6.routing_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.6","typeLabel":"Connected bank account · object"},{"type":"object","title":"Connected bank account","description":"Bank account used for a bank transfer transaction.","required":["format","account_number","bic_swift","id","currency","bank_name","name","country","type","status","balance","last_refreshed_at","last_error_type"],"example":{"format":"iban_bic_swift","bic_swift":"BNPAFRPP"},"properties":{"type":{"type":"string","enum":["connected"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"connected","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["active","error"],"description":"Bank account connection status.","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.status","typeLabel":"enum\u003cstring>"},"balance":{"oneOf":[{"type":"number","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.balance.oneOf.0","typeLabel":"number"},{"type":"null","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.balance","typeLabel":"number | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"last_error_type":{"oneOf":[{"type":"string","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.last_error_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.last_error_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.last_error_type","typeLabel":"enum\u003cstring> | null"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.country","typeLabel":"string | null"},"format":{"type":"string","enum":["account_number_bic_swift"],"description":"Bank account details format.","example":"account_number_bic_swift","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.format","typeLabel":"enum\u003cstring>"},"account_number":{"type":"string","description":"Account number.","example":"000123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.account_number","typeLabel":"string"},"bic_swift":{"type":"string","description":"BIC or SWIFT code.","example":"BNPAFRPP","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7.bic_swift","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.7","typeLabel":"Connected bank account · object"},{"type":"null","description":"Bank account used for a bank transfer transaction.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account.oneOf.8","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.bank_account","typeLabel":"Standard bank account · object · Standard bank account · object · Standard bank account · object · Standard bank account · object · Connected bank account · object · Connected bank account · object · Connected bank account · object · Connected bank account · object · null"},"status":{"type":"string","enum":["scheduled","to_process","pending","settled","cancelled"],"description":"\nTransaction status.\n\n- `scheduled`: The transaction is scheduled to be processed in the future.\n- `to_process`: The transaction is waiting to be processed by our system.\n- `pending`: The transaction has been authorized by the related payment processor, but the banking transaction is not yet settled.\n- `settled`: The transaction has been cleared on the banking side, the money transfer is fully completed.\n- `cancelled`: The transaction has been cancelled and won't be processed again.\n ","example":"settled","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.2","typeLabel":"Transaction Transfer · object"},{"type":"object","title":"Transaction Transfer failed","required":["status","error_type","error_message","payment_method_type","bank_account","id","type","amount","currency","customer_id","provider_id","process_at","settled_at","created_at","updated_at","refunded_at","original_transaction_id","reversed_at","last_refreshed_at","provider_fee","chargeback","integrations"],"properties":{"id":{"type":"string","description":"Transaction ID.","example":"tra_2QdJDDUej969ev","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.id","typeLabel":"string"},"type":{"type":"string","enum":["subscription","one_time","refund","chargeback"],"description":"\nTransaction type.\n\n- `subscription`: The transaction is related to a subscription payment.\n- `one_time`: The transaction is related to a one-time payment.\n- `refund`: The transaction is related to a refund payment.\n- `chargeback`: The transaction records funds withdrawn after a payment dispute.\n ","example":"subscription","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Transaction amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Transaction currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.currency","typeLabel":"enum\u003cstring>"},"customer_id":{"type":"string","description":"ID of the customer linked to the transaction.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.customer_id","typeLabel":"string"},"provider_id":{"oneOf":[{"type":"string","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.provider_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.provider_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.provider_id","typeLabel":"string | null"},"process_at":{"type":"string","format":"date-time","description":"Date corresponding to the processing of the transaction. If in the future, the transaction is scheduled to be processed.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.process_at","typeLabel":"string\u003cdate-time>"},"settled_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.settled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.settled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.settled_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","description":"Date the transaction was recorded in Hyperline, independent of its processing date.","example":"2026-11-12T10:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date the transaction or its invoice allocations were last updated in Hyperline. Use the updated_at filters to sync changes incrementally.","example":"2026-11-12T11:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.updated_at","typeLabel":"string\u003cdate-time>"},"refunded_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.refunded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.refunded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.refunded_at","typeLabel":"string\u003cdate-time> | null"},"original_transaction_id":{"oneOf":[{"type":"string","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.original_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.original_transaction_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.original_transaction_id","typeLabel":"string | null"},"reversed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.reversed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.reversed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.reversed_at","typeLabel":"string\u003cdate-time> | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"provider_fee":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.provider_fee.oneOf.0.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.provider_fee.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"exchange_rate":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.provider_fee.oneOf.0.exchange_rate.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.provider_fee.oneOf.0.exchange_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.provider_fee.oneOf.0.exchange_rate","typeLabel":"number | null"}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.provider_fee.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit."},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR"},"exchange_rate":{"oneOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.provider_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.provider_fee","typeLabel":"object | null"},"chargeback":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.chargeback.oneOf.0.amount","typeLabel":"number"},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.chargeback.oneOf.0.last_chargeback_at","typeLabel":"string\u003cdate-time>"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.chargeback.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.chargeback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.chargeback","typeLabel":"object | null"},"integrations":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.integrations.items.[INDEX].entity_id","typeLabel":"string"},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","paypal","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.integrations.items.[INDEX].provider_name","typeLabel":"enum\u003cstring>"},"provider_account_id":{"type":"string","description":"ID of the connected provider account.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.integrations.items.[INDEX].provider_account_id","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.integrations.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.integrations.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.integrations.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.integrations.items.[INDEX].activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.integrations.items.[INDEX].activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.integrations.items.[INDEX].activated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["entity_id","provider_name","provider_account_id"],"description":"Reference to the entity in an external provider.","example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.integrations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.integrations","typeLabel":"object[]"},"payment_method_type":{"type":"string","enum":["transfer","transfer_automated"],"description":"Payment method type used for the transaction.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.payment_method_type","typeLabel":"enum\u003cstring>"},"bank_account":{"oneOf":[{"type":"object","title":"Standard bank account","description":"Bank account used for a bank transfer transaction.","required":["format","iban","bic_swift","id","currency","bank_name","name","country","type"],"example":{"format":"iban_bic_swift","iban":"FR7630006000011234567890189","bic_swift":"BNPAFRPP"},"properties":{"type":{"type":"string","enum":["standard"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"standard","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.country","typeLabel":"string | null"},"format":{"type":"string","enum":["iban_bic_swift"],"description":"Bank account details format.","example":"iban_bic_swift","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.format","typeLabel":"enum\u003cstring>"},"iban":{"type":"string","description":"IBAN.","example":"FR7630006000011234567890189","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.iban","typeLabel":"string"},"bic_swift":{"oneOf":[{"type":"string","description":"BIC or SWIFT code.","example":"BNPAFRPP","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.bic_swift.oneOf.0","typeLabel":"string"},{"type":"null","description":"BIC or SWIFT code.","example":"BNPAFRPP","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.bic_swift.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0.bic_swift","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.0","typeLabel":"Standard bank account · object"},{"type":"object","title":"Standard bank account","description":"Bank account used for a bank transfer transaction.","required":["format","sort_code","account_number","id","currency","bank_name","name","country","type"],"example":{"format":"iban_bic_swift"},"properties":{"type":{"type":"string","enum":["standard"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"standard","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.country","typeLabel":"string | null"},"format":{"type":"string","enum":["sort_code_account_number"],"description":"Bank account details format.","example":"sort_code_account_number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.format","typeLabel":"enum\u003cstring>"},"sort_code":{"type":"string","description":"Sort code.","example":"123456","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.sort_code","typeLabel":"string"},"account_number":{"type":"string","description":"Account number.","example":"000123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1.account_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.1","typeLabel":"Standard bank account · object"},{"type":"object","title":"Standard bank account","description":"Bank account used for a bank transfer transaction.","required":["format","account_number","routing_number","id","currency","bank_name","name","country","type"],"example":{"format":"iban_bic_swift"},"properties":{"type":{"type":"string","enum":["standard"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"standard","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.country","typeLabel":"string | null"},"format":{"type":"string","enum":["account_number_routing_number"],"description":"Bank account details format.","example":"account_number_routing_number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.format","typeLabel":"enum\u003cstring>"},"account_number":{"type":"string","description":"Account number.","example":"000123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.account_number","typeLabel":"string"},"routing_number":{"type":"string","description":"Routing number.","example":"021000021","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2.routing_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.2","typeLabel":"Standard bank account · object"},{"type":"object","title":"Standard bank account","description":"Bank account used for a bank transfer transaction.","required":["format","account_number","bic_swift","id","currency","bank_name","name","country","type"],"example":{"format":"iban_bic_swift","bic_swift":"BNPAFRPP"},"properties":{"type":{"type":"string","enum":["standard"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"standard","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.country","typeLabel":"string | null"},"format":{"type":"string","enum":["account_number_bic_swift"],"description":"Bank account details format.","example":"account_number_bic_swift","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.format","typeLabel":"enum\u003cstring>"},"account_number":{"type":"string","description":"Account number.","example":"000123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.account_number","typeLabel":"string"},"bic_swift":{"type":"string","description":"BIC or SWIFT code.","example":"BNPAFRPP","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3.bic_swift","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.3","typeLabel":"Standard bank account · object"},{"type":"object","title":"Connected bank account","description":"Bank account used for a bank transfer transaction.","required":["format","iban","bic_swift","id","currency","bank_name","name","country","type","status","balance","last_refreshed_at","last_error_type"],"example":{"format":"iban_bic_swift","iban":"FR7630006000011234567890189","bic_swift":"BNPAFRPP"},"properties":{"type":{"type":"string","enum":["connected"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"connected","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["active","error"],"description":"Bank account connection status.","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.status","typeLabel":"enum\u003cstring>"},"balance":{"oneOf":[{"type":"number","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.balance.oneOf.0","typeLabel":"number"},{"type":"null","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.balance","typeLabel":"number | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"last_error_type":{"oneOf":[{"type":"string","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.last_error_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.last_error_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.last_error_type","typeLabel":"enum\u003cstring> | null"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.country","typeLabel":"string | null"},"format":{"type":"string","enum":["iban_bic_swift"],"description":"Bank account details format.","example":"iban_bic_swift","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.format","typeLabel":"enum\u003cstring>"},"iban":{"type":"string","description":"IBAN.","example":"FR7630006000011234567890189","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.iban","typeLabel":"string"},"bic_swift":{"oneOf":[{"type":"string","description":"BIC or SWIFT code.","example":"BNPAFRPP","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.bic_swift.oneOf.0","typeLabel":"string"},{"type":"null","description":"BIC or SWIFT code.","example":"BNPAFRPP","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.bic_swift.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4.bic_swift","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.4","typeLabel":"Connected bank account · object"},{"type":"object","title":"Connected bank account","description":"Bank account used for a bank transfer transaction.","required":["format","sort_code","account_number","id","currency","bank_name","name","country","type","status","balance","last_refreshed_at","last_error_type"],"example":{"format":"iban_bic_swift"},"properties":{"type":{"type":"string","enum":["connected"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"connected","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["active","error"],"description":"Bank account connection status.","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.status","typeLabel":"enum\u003cstring>"},"balance":{"oneOf":[{"type":"number","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.balance.oneOf.0","typeLabel":"number"},{"type":"null","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.balance","typeLabel":"number | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"last_error_type":{"oneOf":[{"type":"string","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.last_error_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.last_error_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.last_error_type","typeLabel":"enum\u003cstring> | null"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.country","typeLabel":"string | null"},"format":{"type":"string","enum":["sort_code_account_number"],"description":"Bank account details format.","example":"sort_code_account_number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.format","typeLabel":"enum\u003cstring>"},"sort_code":{"type":"string","description":"Sort code.","example":"123456","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.sort_code","typeLabel":"string"},"account_number":{"type":"string","description":"Account number.","example":"000123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5.account_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.5","typeLabel":"Connected bank account · object"},{"type":"object","title":"Connected bank account","description":"Bank account used for a bank transfer transaction.","required":["format","account_number","routing_number","id","currency","bank_name","name","country","type","status","balance","last_refreshed_at","last_error_type"],"example":{"format":"iban_bic_swift"},"properties":{"type":{"type":"string","enum":["connected"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"connected","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["active","error"],"description":"Bank account connection status.","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.status","typeLabel":"enum\u003cstring>"},"balance":{"oneOf":[{"type":"number","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.balance.oneOf.0","typeLabel":"number"},{"type":"null","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.balance","typeLabel":"number | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"last_error_type":{"oneOf":[{"type":"string","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.last_error_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.last_error_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.last_error_type","typeLabel":"enum\u003cstring> | null"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.country","typeLabel":"string | null"},"format":{"type":"string","enum":["account_number_routing_number"],"description":"Bank account details format.","example":"account_number_routing_number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.format","typeLabel":"enum\u003cstring>"},"account_number":{"type":"string","description":"Account number.","example":"000123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.account_number","typeLabel":"string"},"routing_number":{"type":"string","description":"Routing number.","example":"021000021","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6.routing_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.6","typeLabel":"Connected bank account · object"},{"type":"object","title":"Connected bank account","description":"Bank account used for a bank transfer transaction.","required":["format","account_number","bic_swift","id","currency","bank_name","name","country","type","status","balance","last_refreshed_at","last_error_type"],"example":{"format":"iban_bic_swift","bic_swift":"BNPAFRPP"},"properties":{"type":{"type":"string","enum":["connected"],"description":"Bank account type.\n\n- `standard`: Bank account not connected through open banking.\n- `connected`: Bank account connected through open banking.\n","example":"connected","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["active","error"],"description":"Bank account connection status.","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.status","typeLabel":"enum\u003cstring>"},"balance":{"oneOf":[{"type":"number","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.balance.oneOf.0","typeLabel":"number"},{"type":"null","description":"Latest known balance for connected bank accounts, expressed in the currency's smallest unit.","example":120500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.balance","typeLabel":"number | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the connected bank account was last refreshed.","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"last_error_type":{"oneOf":[{"type":"string","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.last_error_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["provider_error","invalid_credentials","unknown"],"description":"Latest connection error type, when the account is errored.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.last_error_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.last_error_type","typeLabel":"enum\u003cstring> | null"},"id":{"type":"string","description":"Bank account ID.","example":"bac_KJyPrMA1toAqRG","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.id","typeLabel":"string"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Bank account currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.currency","typeLabel":"enum\u003cstring>"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name.","example":"Fake bank","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.bank_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.bank_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account display name.","example":"Main account","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.name","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank account country.","example":"FR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.country","typeLabel":"string | null"},"format":{"type":"string","enum":["account_number_bic_swift"],"description":"Bank account details format.","example":"account_number_bic_swift","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.format","typeLabel":"enum\u003cstring>"},"account_number":{"type":"string","description":"Account number.","example":"000123456789","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.account_number","typeLabel":"string"},"bic_swift":{"type":"string","description":"BIC or SWIFT code.","example":"BNPAFRPP","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7.bic_swift","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.7","typeLabel":"Connected bank account · object"},{"type":"null","description":"Bank account used for a bank transfer transaction.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account.oneOf.8","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.bank_account","typeLabel":"Standard bank account · object · Standard bank account · object · Standard bank account · object · Standard bank account · object · Connected bank account · object · Connected bank account · object · Connected bank account · object · Connected bank account · object · null"},"status":{"type":"string","enum":["failed"],"description":"\nTransaction status.\n\n- `failed`: The transaction failed.\n ","example":"failed","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.status","typeLabel":"enum\u003cstring>"},"error_type":{"oneOf":[{"type":"string","enum":["authentication_required","declined","fraud","insufficient_funds","mandate_invalid","payment_method_authorization_error","payment_method_declined","payment_method_expired","payment_method_invalid","payment_method_not_supported","processing_error","provider_error","unknown"],"description":"\nTransaction error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `payment_method_authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `payment_method_declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `payment_method_expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `payment_method_invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `payment_method_not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `declined`: The payment was declined for a variety of reasons such as security violation, banking service not available, transaction not allowed, etc.\n- `fraud`: The payment provider suspected the transaction was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `processing_error`: The payment couldn't be processed by the issuer for an unknown reason.\n- `provider_error`: An error occurred when contacting the payment provider to initiate the transaction.\n- `unknown`: A generic error happened on the payment provider side.\n ","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.error_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["authentication_required","declined","fraud","insufficient_funds","mandate_invalid","payment_method_authorization_error","payment_method_declined","payment_method_expired","payment_method_invalid","payment_method_not_supported","processing_error","provider_error","unknown"],"description":"\nTransaction error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `payment_method_authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `payment_method_declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `payment_method_expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `payment_method_invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `payment_method_not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `declined`: The payment was declined for a variety of reasons such as security violation, banking service not available, transaction not allowed, etc.\n- `fraud`: The payment provider suspected the transaction was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `processing_error`: The payment couldn't be processed by the issuer for an unknown reason.\n- `provider_error`: An error occurred when contacting the payment provider to initiate the transaction.\n- `unknown`: A generic error happened on the payment provider side.\n ","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.error_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.error_type","typeLabel":"enum\u003cstring> | null"},"error_message":{"oneOf":[{"type":"string","description":"Details of the error.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.error_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Details of the error.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.error_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3.error_message","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.3","typeLabel":"Transaction Transfer failed · object"},{"type":"object","title":"Transaction Wallet","required":["status","payment_method_type","wallet_id","id","type","amount","currency","customer_id","provider_id","process_at","settled_at","created_at","updated_at","refunded_at","original_transaction_id","reversed_at","last_refreshed_at","provider_fee","chargeback","integrations"],"properties":{"id":{"type":"string","description":"Transaction ID.","example":"tra_2QdJDDUej969ev","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.id","typeLabel":"string"},"type":{"type":"string","enum":["subscription","one_time","refund","chargeback"],"description":"\nTransaction type.\n\n- `subscription`: The transaction is related to a subscription payment.\n- `one_time`: The transaction is related to a one-time payment.\n- `refund`: The transaction is related to a refund payment.\n- `chargeback`: The transaction records funds withdrawn after a payment dispute.\n ","example":"subscription","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Transaction amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Transaction currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.currency","typeLabel":"enum\u003cstring>"},"customer_id":{"type":"string","description":"ID of the customer linked to the transaction.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.customer_id","typeLabel":"string"},"provider_id":{"oneOf":[{"type":"string","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.provider_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.provider_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.provider_id","typeLabel":"string | null"},"process_at":{"type":"string","format":"date-time","description":"Date corresponding to the processing of the transaction. If in the future, the transaction is scheduled to be processed.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.process_at","typeLabel":"string\u003cdate-time>"},"settled_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.settled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.settled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.settled_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","description":"Date the transaction was recorded in Hyperline, independent of its processing date.","example":"2026-11-12T10:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date the transaction or its invoice allocations were last updated in Hyperline. Use the updated_at filters to sync changes incrementally.","example":"2026-11-12T11:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.updated_at","typeLabel":"string\u003cdate-time>"},"refunded_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.refunded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.refunded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.refunded_at","typeLabel":"string\u003cdate-time> | null"},"original_transaction_id":{"oneOf":[{"type":"string","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.original_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.original_transaction_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.original_transaction_id","typeLabel":"string | null"},"reversed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.reversed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.reversed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.reversed_at","typeLabel":"string\u003cdate-time> | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"provider_fee":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.provider_fee.oneOf.0.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.provider_fee.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"exchange_rate":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.provider_fee.oneOf.0.exchange_rate.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.provider_fee.oneOf.0.exchange_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.provider_fee.oneOf.0.exchange_rate","typeLabel":"number | null"}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.provider_fee.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit."},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR"},"exchange_rate":{"oneOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.provider_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.provider_fee","typeLabel":"object | null"},"chargeback":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.chargeback.oneOf.0.amount","typeLabel":"number"},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.chargeback.oneOf.0.last_chargeback_at","typeLabel":"string\u003cdate-time>"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.chargeback.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.chargeback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.chargeback","typeLabel":"object | null"},"integrations":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.integrations.items.[INDEX].entity_id","typeLabel":"string"},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","paypal","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.integrations.items.[INDEX].provider_name","typeLabel":"enum\u003cstring>"},"provider_account_id":{"type":"string","description":"ID of the connected provider account.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.integrations.items.[INDEX].provider_account_id","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.integrations.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.integrations.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.integrations.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.integrations.items.[INDEX].activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.integrations.items.[INDEX].activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.integrations.items.[INDEX].activated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["entity_id","provider_name","provider_account_id"],"description":"Reference to the entity in an external provider.","example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.integrations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.integrations","typeLabel":"object[]"},"payment_method_type":{"type":"string","enum":["wallet"],"description":"Payment method type used for the transaction.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.payment_method_type","typeLabel":"enum\u003cstring>"},"wallet_id":{"type":"string","description":"ID of the wallet used for a wallet transaction.","example":"wal_PPpxP5d3uvgiTT","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.wallet_id","typeLabel":"string"},"status":{"type":"string","enum":["scheduled","to_process","pending","settled","cancelled"],"description":"\nTransaction status.\n\n- `scheduled`: The transaction is scheduled to be processed in the future.\n- `to_process`: The transaction is waiting to be processed by our system.\n- `pending`: The transaction has been authorized by the related payment processor, but the banking transaction is not yet settled.\n- `settled`: The transaction has been cleared on the banking side, the money transfer is fully completed.\n- `cancelled`: The transaction has been cancelled and won't be processed again.\n ","example":"settled","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.4","typeLabel":"Transaction Wallet · object"},{"type":"object","title":"Transaction Wallet failed","required":["status","error_type","error_message","payment_method_type","wallet_id","id","type","amount","currency","customer_id","provider_id","process_at","settled_at","created_at","updated_at","refunded_at","original_transaction_id","reversed_at","last_refreshed_at","provider_fee","chargeback","integrations"],"properties":{"id":{"type":"string","description":"Transaction ID.","example":"tra_2QdJDDUej969ev","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.id","typeLabel":"string"},"type":{"type":"string","enum":["subscription","one_time","refund","chargeback"],"description":"\nTransaction type.\n\n- `subscription`: The transaction is related to a subscription payment.\n- `one_time`: The transaction is related to a one-time payment.\n- `refund`: The transaction is related to a refund payment.\n- `chargeback`: The transaction records funds withdrawn after a payment dispute.\n ","example":"subscription","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Transaction amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Transaction currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.currency","typeLabel":"enum\u003cstring>"},"customer_id":{"type":"string","description":"ID of the customer linked to the transaction.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.customer_id","typeLabel":"string"},"provider_id":{"oneOf":[{"type":"string","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.provider_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.provider_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.provider_id","typeLabel":"string | null"},"process_at":{"type":"string","format":"date-time","description":"Date corresponding to the processing of the transaction. If in the future, the transaction is scheduled to be processed.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.process_at","typeLabel":"string\u003cdate-time>"},"settled_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.settled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.settled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.settled_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","description":"Date the transaction was recorded in Hyperline, independent of its processing date.","example":"2026-11-12T10:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date the transaction or its invoice allocations were last updated in Hyperline. Use the updated_at filters to sync changes incrementally.","example":"2026-11-12T11:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.updated_at","typeLabel":"string\u003cdate-time>"},"refunded_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.refunded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.refunded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.refunded_at","typeLabel":"string\u003cdate-time> | null"},"original_transaction_id":{"oneOf":[{"type":"string","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.original_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.original_transaction_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.original_transaction_id","typeLabel":"string | null"},"reversed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.reversed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.reversed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.reversed_at","typeLabel":"string\u003cdate-time> | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"provider_fee":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.provider_fee.oneOf.0.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.provider_fee.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"exchange_rate":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.provider_fee.oneOf.0.exchange_rate.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.provider_fee.oneOf.0.exchange_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.provider_fee.oneOf.0.exchange_rate","typeLabel":"number | null"}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.provider_fee.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit."},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR"},"exchange_rate":{"oneOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.provider_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.provider_fee","typeLabel":"object | null"},"chargeback":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.chargeback.oneOf.0.amount","typeLabel":"number"},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.chargeback.oneOf.0.last_chargeback_at","typeLabel":"string\u003cdate-time>"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.chargeback.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.chargeback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.chargeback","typeLabel":"object | null"},"integrations":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.integrations.items.[INDEX].entity_id","typeLabel":"string"},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","paypal","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.integrations.items.[INDEX].provider_name","typeLabel":"enum\u003cstring>"},"provider_account_id":{"type":"string","description":"ID of the connected provider account.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.integrations.items.[INDEX].provider_account_id","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.integrations.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.integrations.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.integrations.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.integrations.items.[INDEX].activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.integrations.items.[INDEX].activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.integrations.items.[INDEX].activated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["entity_id","provider_name","provider_account_id"],"description":"Reference to the entity in an external provider.","example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.integrations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.integrations","typeLabel":"object[]"},"payment_method_type":{"type":"string","enum":["wallet"],"description":"Payment method type used for the transaction.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.payment_method_type","typeLabel":"enum\u003cstring>"},"wallet_id":{"type":"string","description":"ID of the wallet used for a wallet transaction.","example":"wal_PPpxP5d3uvgiTT","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.wallet_id","typeLabel":"string"},"status":{"type":"string","enum":["failed"],"description":"\nTransaction status.\n\n- `failed`: The transaction failed.\n ","example":"failed","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.status","typeLabel":"enum\u003cstring>"},"error_type":{"oneOf":[{"type":"string","enum":["authentication_required","declined","fraud","insufficient_funds","mandate_invalid","payment_method_authorization_error","payment_method_declined","payment_method_expired","payment_method_invalid","payment_method_not_supported","processing_error","provider_error","unknown"],"description":"\nTransaction error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `payment_method_authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `payment_method_declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `payment_method_expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `payment_method_invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `payment_method_not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `declined`: The payment was declined for a variety of reasons such as security violation, banking service not available, transaction not allowed, etc.\n- `fraud`: The payment provider suspected the transaction was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `processing_error`: The payment couldn't be processed by the issuer for an unknown reason.\n- `provider_error`: An error occurred when contacting the payment provider to initiate the transaction.\n- `unknown`: A generic error happened on the payment provider side.\n ","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.error_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["authentication_required","declined","fraud","insufficient_funds","mandate_invalid","payment_method_authorization_error","payment_method_declined","payment_method_expired","payment_method_invalid","payment_method_not_supported","processing_error","provider_error","unknown"],"description":"\nTransaction error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `payment_method_authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `payment_method_declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `payment_method_expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `payment_method_invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `payment_method_not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `declined`: The payment was declined for a variety of reasons such as security violation, banking service not available, transaction not allowed, etc.\n- `fraud`: The payment provider suspected the transaction was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `processing_error`: The payment couldn't be processed by the issuer for an unknown reason.\n- `provider_error`: An error occurred when contacting the payment provider to initiate the transaction.\n- `unknown`: A generic error happened on the payment provider side.\n ","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.error_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.error_type","typeLabel":"enum\u003cstring> | null"},"error_message":{"oneOf":[{"type":"string","description":"Details of the error.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.error_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Details of the error.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.error_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5.error_message","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.5","typeLabel":"Transaction Wallet failed · object"},{"type":"object","title":"Transaction External","required":["status","payment_method_type","id","type","amount","currency","customer_id","provider_id","process_at","settled_at","created_at","updated_at","refunded_at","original_transaction_id","reversed_at","last_refreshed_at","provider_fee","chargeback","integrations"],"properties":{"id":{"type":"string","description":"Transaction ID.","example":"tra_2QdJDDUej969ev","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.id","typeLabel":"string"},"type":{"type":"string","enum":["subscription","one_time","refund","chargeback"],"description":"\nTransaction type.\n\n- `subscription`: The transaction is related to a subscription payment.\n- `one_time`: The transaction is related to a one-time payment.\n- `refund`: The transaction is related to a refund payment.\n- `chargeback`: The transaction records funds withdrawn after a payment dispute.\n ","example":"subscription","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Transaction amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Transaction currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.currency","typeLabel":"enum\u003cstring>"},"customer_id":{"type":"string","description":"ID of the customer linked to the transaction.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.customer_id","typeLabel":"string"},"provider_id":{"oneOf":[{"type":"string","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.provider_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.provider_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.provider_id","typeLabel":"string | null"},"process_at":{"type":"string","format":"date-time","description":"Date corresponding to the processing of the transaction. If in the future, the transaction is scheduled to be processed.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.process_at","typeLabel":"string\u003cdate-time>"},"settled_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.settled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.settled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.settled_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","description":"Date the transaction was recorded in Hyperline, independent of its processing date.","example":"2026-11-12T10:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date the transaction or its invoice allocations were last updated in Hyperline. Use the updated_at filters to sync changes incrementally.","example":"2026-11-12T11:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.updated_at","typeLabel":"string\u003cdate-time>"},"refunded_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.refunded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.refunded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.refunded_at","typeLabel":"string\u003cdate-time> | null"},"original_transaction_id":{"oneOf":[{"type":"string","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.original_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.original_transaction_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.original_transaction_id","typeLabel":"string | null"},"reversed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.reversed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.reversed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.reversed_at","typeLabel":"string\u003cdate-time> | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"provider_fee":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.provider_fee.oneOf.0.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.provider_fee.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"exchange_rate":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.provider_fee.oneOf.0.exchange_rate.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.provider_fee.oneOf.0.exchange_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.provider_fee.oneOf.0.exchange_rate","typeLabel":"number | null"}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.provider_fee.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit."},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR"},"exchange_rate":{"oneOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.provider_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.provider_fee","typeLabel":"object | null"},"chargeback":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.chargeback.oneOf.0.amount","typeLabel":"number"},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.chargeback.oneOf.0.last_chargeback_at","typeLabel":"string\u003cdate-time>"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.chargeback.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.chargeback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.chargeback","typeLabel":"object | null"},"integrations":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.integrations.items.[INDEX].entity_id","typeLabel":"string"},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","paypal","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.integrations.items.[INDEX].provider_name","typeLabel":"enum\u003cstring>"},"provider_account_id":{"type":"string","description":"ID of the connected provider account.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.integrations.items.[INDEX].provider_account_id","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.integrations.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.integrations.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.integrations.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.integrations.items.[INDEX].activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.integrations.items.[INDEX].activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.integrations.items.[INDEX].activated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["entity_id","provider_name","provider_account_id"],"description":"Reference to the entity in an external provider.","example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.integrations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.integrations","typeLabel":"object[]"},"payment_method_type":{"type":"string","enum":["external"],"description":"Payment method type used for the transaction.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.payment_method_type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["scheduled","to_process","pending","settled","cancelled"],"description":"\nTransaction status.\n\n- `scheduled`: The transaction is scheduled to be processed in the future.\n- `to_process`: The transaction is waiting to be processed by our system.\n- `pending`: The transaction has been authorized by the related payment processor, but the banking transaction is not yet settled.\n- `settled`: The transaction has been cleared on the banking side, the money transfer is fully completed.\n- `cancelled`: The transaction has been cancelled and won't be processed again.\n ","example":"settled","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.6","typeLabel":"Transaction External · object"},{"type":"object","title":"Transaction External failed","required":["status","error_type","error_message","payment_method_type","id","type","amount","currency","customer_id","provider_id","process_at","settled_at","created_at","updated_at","refunded_at","original_transaction_id","reversed_at","last_refreshed_at","provider_fee","chargeback","integrations"],"properties":{"id":{"type":"string","description":"Transaction ID.","example":"tra_2QdJDDUej969ev","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.id","typeLabel":"string"},"type":{"type":"string","enum":["subscription","one_time","refund","chargeback"],"description":"\nTransaction type.\n\n- `subscription`: The transaction is related to a subscription payment.\n- `one_time`: The transaction is related to a one-time payment.\n- `refund`: The transaction is related to a refund payment.\n- `chargeback`: The transaction records funds withdrawn after a payment dispute.\n ","example":"subscription","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Transaction amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Transaction currency.","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.currency","typeLabel":"enum\u003cstring>"},"customer_id":{"type":"string","description":"ID of the customer linked to the transaction.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.customer_id","typeLabel":"string"},"provider_id":{"oneOf":[{"type":"string","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.provider_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deprecated field, please use `integrations[].entity_id`.","deprecated":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.provider_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.provider_id","typeLabel":"string | null"},"process_at":{"type":"string","format":"date-time","description":"Date corresponding to the processing of the transaction. If in the future, the transaction is scheduled to be processed.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.process_at","typeLabel":"string\u003cdate-time>"},"settled_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.settled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the transaction was settled. For provider transactions, this is derived from provider settlement data when available.","example":"2024-11-12T07:38:39.222Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.settled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.settled_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","description":"Date the transaction was recorded in Hyperline, independent of its processing date.","example":"2026-11-12T10:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date the transaction or its invoice allocations were last updated in Hyperline. Use the updated_at filters to sync changes incrementally.","example":"2026-11-12T11:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.updated_at","typeLabel":"string\u003cdate-time>"},"refunded_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.refunded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the refund of the transaction.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.refunded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.refunded_at","typeLabel":"string\u003cdate-time> | null"},"original_transaction_id":{"oneOf":[{"type":"string","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.original_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Original payment transaction ID for a refund or chargeback.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.original_transaction_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.original_transaction_id","typeLabel":"string | null"},"reversed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.reversed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when a chargeback withdrawal was reversed.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.reversed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.reversed_at","typeLabel":"string\u003cdate-time> | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date corresponding to the last synchronization of the details with the payment provider.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.last_refreshed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"provider_fee":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.provider_fee.oneOf.0.amount","typeLabel":"number"},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.provider_fee.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"exchange_rate":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.provider_fee.oneOf.0.exchange_rate.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.provider_fee.oneOf.0.exchange_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.provider_fee.oneOf.0.exchange_rate","typeLabel":"number | null"}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.provider_fee.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Monetary amount. Expressed in currency's smallest unit."},"currency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).","example":"EUR"},"exchange_rate":{"oneOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","currency","exchange_rate"],"description":"Fee applied by the Payment Service Provider. Only supported for Stripe.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.provider_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.provider_fee","typeLabel":"object | null"},"chargeback":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.chargeback.oneOf.0.amount","typeLabel":"number"},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.chargeback.oneOf.0.last_chargeback_at","typeLabel":"string\u003cdate-time>"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.chargeback.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"Total chargeback loss amount.","example":31500},"last_chargeback_at":{"type":"string","format":"date-time","description":"Date corresponding to the last chargeback loss event.","example":"2024-10-13T10:00:01.860Z"}},"required":["amount","last_chargeback_at"],"description":"Deprecated field. Use transactions where `type` is `chargeback`; `original_transaction_id` identifies the affected payment transaction.","deprecated":true,"example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.chargeback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.chargeback","typeLabel":"object | null"},"integrations":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","description":"ID of the entity in the provider.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.integrations.items.[INDEX].entity_id","typeLabel":"string"},"provider_name":{"type":"string","enum":["adyen","stripe","mollie","gocardless","airwallex","paypal","salesforce","hubspot","attio","xero","pennylane","zoho-books","exact-online","quickbooks","netsuite","rillet","campfire","dualentry","datev","anrok","sphere","chargebee","slack","plain","zendesk","pylon","intercom","front","helpscout","claap","grain","gong","jiminny","modjo","posthog"],"description":"Provider name.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.integrations.items.[INDEX].provider_name","typeLabel":"enum\u003cstring>"},"provider_account_id":{"type":"string","description":"ID of the connected provider account.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.integrations.items.[INDEX].provider_account_id","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.integrations.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Creation date of the entity in the provider, when it was imported from there. Exposed on products, coupons and subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.integrations.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.integrations.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.integrations.items.[INDEX].activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Activation date of the entity in the provider, when it was imported from there. Exposed on subscriptions; `null` when the provider does not report one.","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.integrations.items.[INDEX].activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.integrations.items.[INDEX].activated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["entity_id","provider_name","provider_account_id"],"description":"Reference to the entity in an external provider.","example":{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.integrations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.integrations","typeLabel":"object[]"},"payment_method_type":{"type":"string","enum":["external"],"description":"Payment method type used for the transaction.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.payment_method_type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["failed"],"description":"\nTransaction status.\n\n- `failed`: The transaction failed.\n ","example":"failed","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.status","typeLabel":"enum\u003cstring>"},"error_type":{"oneOf":[{"type":"string","enum":["authentication_required","declined","fraud","insufficient_funds","mandate_invalid","payment_method_authorization_error","payment_method_declined","payment_method_expired","payment_method_invalid","payment_method_not_supported","processing_error","provider_error","unknown"],"description":"\nTransaction error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `payment_method_authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `payment_method_declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `payment_method_expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `payment_method_invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `payment_method_not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `declined`: The payment was declined for a variety of reasons such as security violation, banking service not available, transaction not allowed, etc.\n- `fraud`: The payment provider suspected the transaction was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `processing_error`: The payment couldn't be processed by the issuer for an unknown reason.\n- `provider_error`: An error occurred when contacting the payment provider to initiate the transaction.\n- `unknown`: A generic error happened on the payment provider side.\n ","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.error_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["authentication_required","declined","fraud","insufficient_funds","mandate_invalid","payment_method_authorization_error","payment_method_declined","payment_method_expired","payment_method_invalid","payment_method_not_supported","processing_error","provider_error","unknown"],"description":"\nTransaction error type.\n\n- `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n- `payment_method_authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n- `payment_method_declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n- `payment_method_expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n- `payment_method_invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n- `payment_method_not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n- `declined`: The payment was declined for a variety of reasons such as security violation, banking service not available, transaction not allowed, etc.\n- `fraud`: The payment provider suspected the transaction was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n- `processing_error`: The payment couldn't be processed by the issuer for an unknown reason.\n- `provider_error`: An error occurred when contacting the payment provider to initiate the transaction.\n- `unknown`: A generic error happened on the payment provider side.\n ","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.error_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.error_type","typeLabel":"enum\u003cstring> | null"},"error_message":{"oneOf":[{"type":"string","description":"Details of the error.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.error_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Details of the error.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.error_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7.error_message","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX].oneOf.7","typeLabel":"Transaction External failed · object"}],"uniqueKey":"data.items.[INDEX].transactions.items.[INDEX]","typeLabel":"Transaction Card/debit · object | Transaction Card/debit failed · object | Transaction Transfer · object | Transaction Transfer failed · object | Transaction Wallet · object | Transaction Wallet failed · object | Transaction External · object | Transaction External failed · object"},"description":"List of transactions related to the invoice.","isRequired":true,"uniqueKey":"data.items.[INDEX].transactions","typeLabel":"(Transaction Card/debit · object | Transaction Card/debit failed · object | Transaction Transfer · object | Transaction Transfer failed · object | Transaction Wallet · object | Transaction Wallet failed · object | Transaction External · object | Transaction External failed · object)[]"},"public_url":{"type":"string","format":"uri","description":"Public URL of the invoice page where the customer can pay the invoice.","isRequired":true,"uniqueKey":"data.items.[INDEX].public_url","typeLabel":"string\u003curi>"},"issued_at":{"type":"string","format":"date-time","description":"Issue date of the invoice.","example":"2026-10-13T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].issued_at","typeLabel":"string\u003cdate-time>"},"allocations":{"type":"array","items":{"type":"object","properties":{"invoice_id":{"type":"string","description":"ID of the invoice receiving the credit.","example":"inv_2QdJDDUej969ev","isRequired":true,"uniqueKey":"data.items.[INDEX].allocations.items.[INDEX].invoice_id","typeLabel":"string"},"amount":{"type":"number","description":"Credit amount applied to the invoice, in the currency's smallest unit.","example":780000,"isRequired":true,"uniqueKey":"data.items.[INDEX].allocations.items.[INDEX].amount","typeLabel":"number"}},"required":["invoice_id","amount"],"uniqueKey":"data.items.[INDEX].allocations.items.[INDEX]","typeLabel":"object"},"description":"Current invoice applications made by this credit note. Only present for credit notes.","uniqueKey":"data.items.[INDEX].allocations","typeLabel":"object[]"}},"required":["id","number","type","document_name","status","reference","purchase_order","currency","source","origin","total_amount","amount_due","amount_paid","amount_fixed","amount_excluding_tax","tax_amount","tax_scheme","discount_amount","conversion_rate","converted_amount","converted_at","payment_method_id","bank_account_id","custom_note","additional_info","footer","customer","seller","subscription_id","period_starts_at","period_ends_at","due_at","issuing_method","refunded_at","grace_period_ended_at","settled_at","updated_at","properties","custom_properties","additional_display_fields","original_invoice_id","original_invoice_number","line_items","coupons","transactions","public_url","issued_at"],"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"description":"List of Invoice.","isRequired":true,"uniqueKey":"data","typeLabel":"object[]"},"next_cursor":{"oneOf":[{"type":"string","description":"Cursor to fetch the next page. `null` when there are no more items.","example":null,"isRequired":true,"uniqueKey":"next_cursor.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cursor to fetch the next page. `null` when there are no more items.","example":null,"isRequired":true,"uniqueKey":"next_cursor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_cursor","typeLabel":"string | null"},"has_more":{"type":"boolean","description":"Whether more items are available after this page.","example":false,"isRequired":true,"uniqueKey":"has_more","typeLabel":"boolean"},"total":{"type":"number","description":"Total number of items matching the filters. Only present when `include_total=true` was passed.","example":1,"uniqueKey":"total","typeLabel":"number"}},"required":["data","next_cursor","has_more"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":"inv_1eTaiytfA0i2Va","number":"INV-35","type":"invoice","document_name":null,"status":"paid","reference":"V0KAHOU6J3","purchase_order":"PO-12345","currency":"EUR","source":"hyperline","origin":"subscription","total_amount":24000,"amount_due":0,"amount_paid":24000,"amount_fixed":20000,"amount_excluding_tax":20000,"tax_amount":4000,"tax_scheme":"standard","discount_amount":0,"conversion_rate":1,"converted_amount":24000,"converted_at":"2026-10-13T02:00:00.000Z","payment_method_id":"pm_1ryTrMj4TTAT1N","bank_account_id":"bac_KJyPrMA1toAqRG","custom_note":"Thank you for your purchase!","additional_info":"This invoice must be paid within the payment delay indicated. After this period a late payment penalty of 10% will be applied.","footer":"ACME (Acme SAS) is a company registered in France | SIREN N°123456","customer":{"id":"cus_Typ0px2W0aiEtl","name":"Acme","email":"billing@acme.com","external_id":null,"tax_id":"FR123456789","local_tax_number":"12/345/67890","registration_number":"36252187900034","address":{"name":"Acme","line1":"5 rue de Paradis","line2":null,"city":"Paris","zip":"75010","state":"CA","country":"FR"}},"seller":{"id":"ive_47484fjdhy5","name":"Name of the invoicing entity","tax_id":"FR5878986578","registration_number":"87898657800016","address":{"name":"Acme","line1":"5 rue de Paradis","line2":null,"city":"Paris","zip":"75010","state":"CA","country":"FR"}},"subscription_id":"sub_amiaWZ3lzDIWaoT","period_starts_at":"2026-10-13T00:00:00.000Z","period_ends_at":"2026-11-13T00:00:00.000Z","due_at":"2026-11-12T00:00:00.000Z","issuing_method":"manual","refunded_at":null,"grace_period_ended_at":null,"settled_at":"2026-10-15T14:01:56.000Z","updated_at":"2026-10-15T14:01:56.000Z","properties":null,"custom_properties":null,"additional_display_fields":null,"original_invoice_id":null,"original_invoice_number":null,"line_items":[{"id":"ili_0FACNpeoEFkGu3","name":"Platform access","entry_type":"debit","product_id":"itm_KbLcWt2qm5p1S2","price_configuration_id":"pcf_monthly","product_type":"flat_fee","units_count":1,"unit_amount":24000,"amount":24000,"amount_excluding_tax":20000,"tax_rate":20,"tax_rate_id":null,"tax_amount":4000,"discount_amount":0,"discount_percent":123,"period_starts_at":"2026-10-13T00:00:00.000Z","period_ends_at":"2026-11-13T00:00:00.000Z","revenue_type":"recurring","revenue_interval_count":1,"revenue_interval_period":"months","display_unit_amount":true,"display_service_period":true,"subscription_id":"sub_amiaWZ3lzDIWaoT","original_line_item_id":null}],"coupons":[{"id":"cou_DKL4Xcb5VSa8CQ","name":"Partner discount","subscription_coupon_id":"coos_d9pVekhjoGppuX","discount_amount":2000,"discount_percent":null,"line_item_ids":["ili_0FACNpeoEFkGu3"]}],"transactions":[{"id":"tra_2QdJDDUej969ev","type":"subscription","amount":31500,"currency":"EUR","customer_id":"cus_QalW2vTAdkR6IY","provider_id":"\u003cstring>","process_at":"2024-11-12T07:38:39.222Z","settled_at":"2024-11-12T07:38:39.222Z","created_at":"2026-11-12T10:00:00.000Z","updated_at":"2026-11-12T11:00:00.000Z","refunded_at":null,"original_transaction_id":null,"reversed_at":null,"last_refreshed_at":null,"provider_fee":null,"chargeback":null,"integrations":[{"entity_id":"123456789","provider_name":"stripe","provider_account_id":"acc_1234567890"}],"payment_method_type":"card","payment_method":{"id":"pm_1xMpj5bwRqN7LM","status":"active","type":"card","last_4_digits":2718,"expiration_date":"2027-11","brand":"visa"},"status":"settled"}],"public_url":"\u003cstring>","issued_at":"2026-10-13T00:00:00.000Z","allocations":[{"invoice_id":"inv_2QdJDDUej969ev","amount":780000}]}],"next_cursor":null,"has_more":false,"total":1}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"aa26e61e-54ec-470d-9d95-4089fe593c49":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"}}},"servers":{"da140594-2292-43c7-96f8-2d99b8bb723e":{"url":"https://api.hyperline.co"},"94e9cc11-bd27-48d9-8471-85b725affa48":{"url":"https://sandbox.api.hyperline.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi-main.json"},"subdomain":"hyperline","siteName":"Hyperline","title":"List invoices - Hyperline","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T13:17:52.233Z","originalFileLocation":"api-reference/endpoints/invoices/list-invoices.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve existing invoices. By default, invoices with status open are not included.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperline\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List invoices - Hyperline\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve existing invoices. By default, invoices with status open are not included.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperline\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hyperline.co/api-reference/endpoints/invoices/list-invoices\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://app.hyperline.co/auth/background.svg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List invoices - Hyperline\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve existing invoices. By default, invoices with status open are not included.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://app.hyperline.co/auth/background.svg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperline\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A1A1A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hyperline.co/api-reference/endpoints/invoices/list-invoices\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/invoices/list-invoices.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hyperline.co/#organization\",\"name\":\"Hyperline\",\"url\":\"https://docs.hyperline.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hyperline/G-7ZQgHUOVHWwtUN/layout/logo-dark.png?fit=max\u0026auto=format\u0026n=G-7ZQgHUOVHWwtUN\u0026q=85\u0026s=2521f5f5ce4977d387d12aa169a8ee55\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hyperline.co#website\",\"name\":\"Hyperline\",\"url\":\"https://docs.hyperline.co\",\"publisher\":{\"@id\":\"https://docs.hyperline.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/invoices/list-invoices#webpage\",\"url\":\"https://docs.hyperline.co/api-reference/endpoints/invoices/list-invoices\",\"name\":\"List invoices\",\"description\":\"Retrieve existing invoices. By default, invoices with status open are not included.\",\"dateModified\":\"2026-11-15T13:17:52.233Z\",\"isPartOf\":{\"@id\":\"https://docs.hyperline.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/invoices/list-invoices#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/invoices/list-invoices#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.hyperline.co/api-reference/endpoints/accounting-%3E-accounts/get-ledger-account\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Invoicing\",\"item\":\"https://docs.hyperline.co/api-reference/endpoints/invoices/create-credit-note\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List invoices\",\"item\":\"https://docs.hyperline.co/api-reference/endpoints/invoices/list-invoices\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/invoices/list-invoices#apireference\",\"headline\":\"List invoices\",\"name\":\"List invoices\",\"description\":\"Retrieve existing invoices. By default, invoices with status open are not included.\",\"url\":\"https://docs.hyperline.co/api-reference/endpoints/invoices/list-invoices\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/invoices/list-invoices#webpage\"},\"image\":\"https://app.hyperline.co/auth/background.svg\",\"dateModified\":\"2026-11-15T13:17:52.233Z\",\"publisher\":{\"@id\":\"https://docs.hyperline.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hyperline.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperline\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hyperline\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoints/invoices/list-invoices.md","siteName":"Hyperline","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/docs"}]},{"tab":"Developers","icon":"code","groups":[{"group":"Technical documentation","pages":[{"title":"Hyperline for developers","sidebarTitle":"Getting started","mode":"wide","href":"/developers/getting-started"},{"title":"Authentication","href":"/developers/authentication"}]},{"group":"API fundamentals","pages":[{"title":"Pagination and filtering","href":"/developers/pagination"},{"title":"Error handling","href":"/developers/error-handling"},{"title":"Rate limiting","href":"/developers/rate-limiting"},{"title":"Idempotent requests","href":"/developers/idempotent-requests"},{"title":"Currency amounts","href":"/developers/amount"},{"title":"Dates \u0026 timezones","href":"/developers/dates-and-timezones"},{"title":"API upgrades","href":"/developers/upgrades"}]},{"group":"AI / LLMs","pages":[{"title":"Build with LLMs","href":"/developers/ai/overview"},{"title":"Hyperline MCP","sidebarTitle":"MCP server","href":"/developers/ai/mcp"},{"title":"Hyperline CLI","sidebarTitle":"CLI","href":"/developers/ai/cli"}]},{"group":"Integrations","pages":[{"title":"React components","href":"/developers/react-components"},{"title":"Third-party app","href":"/developers/third-party-app"},{"title":"Webhooks","href":"/developers/webhooks"}]},{"group":"API reference","pages":[{"group":"Accounting","tag":"41","expanded":false,"pages":[{"group":"Accounts","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/accounting/accounts/{id}","title":"Get ledger account","href":"/api-reference/endpoints/accounting->-accounts/get-ledger-account"},{"openapi":"get /v1/accounting/accounts","title":"List ledger accounts","href":"/api-reference/endpoints/accounting->-accounts/list-ledger-accounts"},{"openapi":"get /v1/accounting/primary-ledger/accounts","title":"List primary accounts","href":"/api-reference/endpoints/accounting->-accounts/list-primary-accounts"},{"openapi":"post /v1/accounting/accounts","title":"Create ledger account","href":"/api-reference/endpoints/accounting->-accounts/create-ledger-account"},{"openapi":"put /v1/accounting/accounts/{id}","title":"Update ledger account","href":"/api-reference/endpoints/accounting->-accounts/update-ledger-account"},{"openapi":"delete /v1/accounting/accounts/{id}","title":"Delete ledger account","href":"/api-reference/endpoints/accounting->-accounts/delete-ledger-account"}]},{"group":"Journal entries","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/accounting/journal-entries/{id}","title":"Get journal entry","href":"/api-reference/endpoints/accounting->-journal-entries/get-journal-entry"},{"openapi":"get /v1/accounting/journal-entries","title":"List journal entries","href":"/api-reference/endpoints/accounting->-journal-entries/list-journal-entries"},{"openapi":"get /v1/accounting/journal-entry-lines","title":"List journal entry lines","href":"/api-reference/endpoints/accounting->-journal-entries/list-journal-entry-lines"},{"openapi":"post /v1/accounting/journal-entries","title":"Create journal entry","href":"/api-reference/endpoints/accounting->-journal-entries/create-journal-entry"},{"openapi":"post /v1/accounting/journal-entries/recognition-preview","title":"Preview recognition schedule","href":"/api-reference/endpoints/accounting->-journal-entries/preview-recognition-schedule"}]},{"group":"Ledgers","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/accounting/ledgers/{id}","title":"Get ledger","href":"/api-reference/endpoints/accounting->-ledgers/get-ledger"},{"openapi":"get /v1/accounting/ledgers/{id}/close","title":"Get ledger close state","href":"/api-reference/endpoints/accounting->-ledgers/get-ledger-close-state"},{"openapi":"get /v1/accounting/ledgers","title":"List ledgers","href":"/api-reference/endpoints/accounting->-ledgers/list-ledgers"},{"openapi":"get /v1/accounting/ledgers/{id}/close-events","title":"List ledger close events","href":"/api-reference/endpoints/accounting->-ledgers/list-ledger-close-events"},{"openapi":"post /v1/accounting/ledgers","title":"Create ledger","href":"/api-reference/endpoints/accounting->-ledgers/create-ledger"},{"openapi":"put /v1/accounting/ledgers/{id}","title":"Update ledger","href":"/api-reference/endpoints/accounting->-ledgers/update-ledger"},{"openapi":"post /v1/accounting/ledgers/{id}/close","title":"Close ledger period","href":"/api-reference/endpoints/accounting->-ledgers/close-ledger-period"},{"openapi":"post /v1/accounting/ledgers/{id}/reopen","title":"Reopen ledger period","href":"/api-reference/endpoints/accounting->-ledgers/reopen-ledger-period"},{"openapi":"delete /v1/accounting/ledgers/{id}","title":"Delete ledger","href":"/api-reference/endpoints/accounting->-ledgers/delete-ledger"}]},{"group":"Reports","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/accounting/general-ledger/export","title":"Export general ledger","href":"/api-reference/endpoints/accounting->-reports/export-general-ledger"},{"openapi":"post /v1/accounting/income-statement/export","title":"Export income statement","href":"/api-reference/endpoints/accounting->-reports/export-income-statement"}]},{"group":"Revenue recognition","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/accounting/revrec/waterfall","title":"Get revenue recognition waterfall","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-waterfall"},{"openapi":"get /v1/accounting/revrec/waterfall/cell","title":"Get revenue recognition waterfall cell","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-waterfall-cell"},{"openapi":"get /v1/accounting/revrec/unbilled","title":"Get unbilled revenue","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-unbilled-revenue"},{"openapi":"get /v1/accounting/revrec/schedules/{id}","title":"Get revenue recognition schedule","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-schedule"},{"openapi":"get /v1/accounting/revrec/slices/{id}","title":"Get revenue recognition slice","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-slice"},{"openapi":"get /v1/accounting/revrec/schedules","title":"List revenue recognition schedules","href":"/api-reference/endpoints/accounting->-revenue-recognition/list-revenue-recognition-schedules"},{"openapi":"get /v1/accounting/revrec/schedules/{schedule_id}/adjustments","title":"List revenue recognition adjustments","href":"/api-reference/endpoints/accounting->-revenue-recognition/list-revenue-recognition-adjustments"},{"openapi":"post /v1/accounting/revrec/recognized-summary/export","title":"Export recognized revenue summary","href":"/api-reference/endpoints/accounting->-revenue-recognition/export-recognized-revenue-summary"},{"openapi":"post /v1/accounting/revrec/waterfall/export","title":"Export revenue recognition waterfall","href":"/api-reference/endpoints/accounting->-revenue-recognition/export-revenue-recognition-waterfall"},{"openapi":"post /v1/accounting/revrec/schedules/{schedule_id}/reshape/preview","title":"Preview revenue recognition reshape","href":"/api-reference/endpoints/accounting->-revenue-recognition/preview-revenue-recognition-reshape"},{"openapi":"post /v1/accounting/revrec/schedules/{schedule_id}/reshape","title":"Reshape revenue recognition schedule","href":"/api-reference/endpoints/accounting->-revenue-recognition/reshape-revenue-recognition-schedule"}]},{"group":"Rules","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/accounting/rules/tree","title":"Get accounting rule tree","href":"/api-reference/endpoints/accounting->-rules/get-accounting-rule-tree"},{"openapi":"post /v1/accounting/rules/defaults","title":"Get rule defaults","href":"/api-reference/endpoints/accounting->-rules/get-rule-defaults"},{"openapi":"get /v1/accounting/rules/{id}","title":"Get accounting rule","href":"/api-reference/endpoints/accounting->-rules/get-accounting-rule"},{"openapi":"get /v1/accounting/rules","title":"List accounting rules","href":"/api-reference/endpoints/accounting->-rules/list-accounting-rules"},{"openapi":"post /v1/accounting/rules","title":"Create accounting rule","href":"/api-reference/endpoints/accounting->-rules/create-accounting-rule"},{"openapi":"put /v1/accounting/rules/{id}","title":"Update accounting rule","href":"/api-reference/endpoints/accounting->-rules/update-accounting-rule"},{"openapi":"post /v1/accounting/rules/resolve","title":"Resolve accounting rule","href":"/api-reference/endpoints/accounting->-rules/resolve-accounting-rule"},{"openapi":"delete /v1/accounting/rules/{id}","title":"Delete accounting rule","href":"/api-reference/endpoints/accounting->-rules/delete-accounting-rule"}]}]},{"group":"Agents","tag":"39","expanded":false,"pages":[{"group":"Billing","icon":"arrow-turn-down-right","expanded":false,"pages":[{"group":"Costs","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/ai/billing/costs","title":"List cost catalog","href":"/api-reference/endpoints/ai->-costs/list-cost-catalog"},{"openapi":"post /v1/ai/billing/costs/items","title":"Create custom cost item","href":"/api-reference/endpoints/ai->-costs/create-custom-cost-item"},{"openapi":"delete /v1/ai/billing/costs/items/{id}","title":"Remove custom cost item","href":"/api-reference/endpoints/ai->-costs/remove-custom-cost-item"},{"openapi":"delete /v1/ai/billing/costs/overrides/{id}","title":"Remove provider cost override","href":"/api-reference/endpoints/ai->-costs/remove-provider-cost-override"},{"openapi":"put /v1/ai/billing/costs/items/{id}","title":"Replace custom cost item","href":"/api-reference/endpoints/ai->-costs/replace-custom-cost-item"},{"openapi":"put /v1/ai/billing/costs/overrides","title":"Set provider cost override","href":"/api-reference/endpoints/ai->-costs/set-provider-cost-override"}]},{"group":"Plans","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/ai/billing/plans/default","title":"Get default billing plan","href":"/api-reference/endpoints/ai->-billing/get-default-billing-plan"},{"openapi":"get /v1/ai/billing/plans/{id}","title":"Get billing plan","href":"/api-reference/endpoints/ai->-billing/get-billing-plan"},{"openapi":"get /v1/ai/billing/plans","title":"List billing plans","href":"/api-reference/endpoints/ai->-billing/list-billing-plans"},{"openapi":"post /v1/ai/billing/plans","title":"Create billing plan","href":"/api-reference/endpoints/ai->-billing/create-billing-plan"},{"openapi":"post /v1/ai/billing/customers/{id}/apply-default-plan","title":"Apply default billing plan","href":"/api-reference/endpoints/ai->-billing/apply-default-billing-plan"},{"openapi":"delete /v1/ai/billing/plans/default","title":"Clear default billing plan","href":"/api-reference/endpoints/ai->-billing/clear-default-billing-plan"},{"openapi":"put /v1/ai/billing/plans/{id}","title":"Replace billing plan","href":"/api-reference/endpoints/ai->-billing/replace-billing-plan"},{"openapi":"put /v1/ai/billing/plans/default","title":"Set default billing plan","href":"/api-reference/endpoints/ai->-billing/set-default-billing-plan"},{"openapi":"delete /v1/ai/billing/plans/{id}","title":"Delete billing plan","href":"/api-reference/endpoints/ai->-billing/delete-billing-plan"}]},{"group":"Policies","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/ai/billing/customers/{id}/policies/default","title":"Get default billing policy","href":"/api-reference/endpoints/ai->-billing/get-default-billing-policy"},{"openapi":"get /v1/ai/billing/customers/{id}/policies/agents/{agent_slug}","title":"Get billing policy","href":"/api-reference/endpoints/ai->-billing/get-billing-policy"},{"openapi":"get /v1/ai/billing/customers/{id}/policies","title":"List billing policies","href":"/api-reference/endpoints/ai->-billing/list-billing-policies"},{"openapi":"put /v1/ai/billing/customers/{id}/policies/agents/{agent_slug}","title":"Configure billing policy","href":"/api-reference/endpoints/ai->-billing/configure-billing-policy"},{"openapi":"put /v1/ai/billing/customers/{id}/policies/default","title":"Configure default billing policy","href":"/api-reference/endpoints/ai->-billing/configure-default-billing-policy"},{"openapi":"delete /v1/ai/billing/customers/{id}/policies/agents/{agent_slug}","title":"Remove billing policy","href":"/api-reference/endpoints/ai->-billing/remove-billing-policy"},{"openapi":"delete /v1/ai/billing/customers/{id}/policies/default","title":"Remove default billing policy","href":"/api-reference/endpoints/ai->-billing/remove-default-billing-policy"}]},{"group":"Rate cards","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/ai/billing/rate-cards/{id}","title":"Get rate card","href":"/api-reference/endpoints/ai->-billing/get-rate-card"},{"openapi":"get /v1/ai/billing/products/{id}/rate-card","title":"Get product AI rate card","href":"/api-reference/endpoints/ai->-billing/get-product-ai-rate-card"},{"openapi":"get /v1/ai/billing/rate-cards","title":"List rate cards","href":"/api-reference/endpoints/ai->-billing/list-rate-cards"},{"openapi":"post /v1/ai/billing/rate-cards","title":"Create rate card","href":"/api-reference/endpoints/ai->-billing/create-rate-card"},{"openapi":"delete /v1/ai/billing/products/{id}/rate-card","title":"Clear product AI rate card","href":"/api-reference/endpoints/ai->-billing/clear-product-ai-rate-card"},{"openapi":"put /v1/ai/billing/rate-cards/{id}","title":"Replace rate card","href":"/api-reference/endpoints/ai->-billing/replace-rate-card"},{"openapi":"put /v1/ai/billing/products/{id}/rate-card","title":"Set product AI rate card","href":"/api-reference/endpoints/ai->-billing/set-product-ai-rate-card"},{"openapi":"delete /v1/ai/billing/rate-cards/{id}","title":"Delete rate card","href":"/api-reference/endpoints/ai->-billing/delete-rate-card"}]},{"group":"Usage","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/ai/billing/customers/{id}/balance","title":"Get billing balance","href":"/api-reference/endpoints/ai->-billing/get-billing-balance"},{"openapi":"get /v1/ai/billing/customers/{id}/consumption","title":"List consumption","href":"/api-reference/endpoints/ai->-billing/list-consumption"},{"openapi":"post /v1/ai/billing/customers/{id}/windows/reset","title":"Reset allowance windows","href":"/api-reference/endpoints/ai->-billing/reset-allowance-windows"}]}]},{"group":"Ingest","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/ai/billing/snapshot","title":"Get AI billing snapshot","href":"/api-reference/endpoints/ai->-ingest/get-ai-billing-snapshot"},{"openapi":"post /v1/ai/billing/check","title":"Check AI spend allowance","href":"/api-reference/endpoints/ai->-ingest/check-ai-spend-allowance"},{"openapi":"post /v1/ai/billing/consume","title":"Consume AI usage","href":"/api-reference/endpoints/ai->-ingest/consume-ai-usage"},{"openapi":"post /v1/ai/calls","title":"Ingest AI calls","href":"/api-reference/endpoints/ai->-ingest/ingest-ai-calls"}]},{"group":"Monitoring","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/agents/monitoring/analyses/{id}","title":"Get monitoring analysis","href":"/api-reference/endpoints/ai->-monitoring/get-monitoring-analysis"},{"openapi":"get /v1/agents/monitoring/analyses","title":"List monitoring analyses","href":"/api-reference/endpoints/ai->-monitoring/list-monitoring-analyses"}]}]},{"group":"Approvals","tag":"8","expanded":false,"pages":[{"group":"Requests","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/approvals/requests/{id}","title":"Get approval request","href":"/api-reference/endpoints/approval->-requests/get-approval-request"},{"openapi":"post /v1/approvals/requests/{id}/approve","title":"Approve request","href":"/api-reference/endpoints/approval->-requests/approve-request"},{"openapi":"post /v1/approvals/requests/{id}/reject","title":"Reject request","href":"/api-reference/endpoints/approval->-requests/reject-request"}]},{"group":"Workflows","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/approvals/workflows/{id}","title":"Get approval workflow","href":"/api-reference/endpoints/approval->-workflows/get-approval-workflow"},{"openapi":"get /v1/approvals/workflows","title":"List approval workflows","href":"/api-reference/endpoints/approval->-workflows/list-approval-workflows"},{"openapi":"post /v1/approvals/workflows","title":"Create approval workflow","href":"/api-reference/endpoints/approval->-workflows/create-approval-workflow"},{"openapi":"put /v1/approvals/workflows/{id}","title":"Update approval workflow","href":"/api-reference/endpoints/approval->-workflows/update-approval-workflow"},{"openapi":"delete /v1/approvals/workflows/{id}","title":"Delete approval workflow","href":"/api-reference/endpoints/approval->-workflows/delete-approval-workflow"}]}]},{"group":"Audit logs","tag":"1","expanded":false,"pages":[{"openapi":"get /v1/audit-logs","title":"List audit logs","href":"/api-reference/endpoints/audit-logs/list-audit-logs"}]},{"group":"Catalog","tag":"47","expanded":false,"pages":[{"group":"Coupons","icon":"arrow-turn-down-right","expanded":false,"pages":[{"group":"Promotion codes","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/promotion-codes/{id}","title":"Get promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/get-promotion-code"},{"openapi":"get /v1/promotion-codes","title":"List promotion codes","href":"/api-reference/endpoints/coupons->-promotion-codes/list-promotion-codes"},{"openapi":"post /v1/promotion-codes","title":"Create promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/create-promotion-code"},{"openapi":"patch /v1/promotion-codes/{id}","title":"Update promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/update-promotion-code"},{"openapi":"delete /v1/promotion-codes/{id}","title":"Delete promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/delete-promotion-code"}]},{"openapi":"get /v1/coupons/{id}","title":"Get coupon","href":"/api-reference/endpoints/coupons/get-coupon"},{"openapi":"get /v1/coupons","title":"List coupons","href":"/api-reference/endpoints/coupons/list-coupons"},{"openapi":"post /v1/coupons","title":"Create coupon","href":"/api-reference/endpoints/coupons/create-coupon"},{"openapi":"put /v1/coupons/{id}","title":"Update coupon","href":"/api-reference/endpoints/coupons/update-coupon"},{"openapi":"delete /v1/coupons/{id}","title":"Delete coupon","href":"/api-reference/endpoints/coupons/delete-coupon"}]},{"group":"Features","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/features/{code}","title":"Get feature","href":"/api-reference/endpoints/features/get-feature"},{"openapi":"get /v1/features","title":"List features","href":"/api-reference/endpoints/features/list-features"},{"openapi":"post /v1/features","title":"Create feature","href":"/api-reference/endpoints/features/create-feature"},{"openapi":"put /v1/features/{code}","title":"Update feature","href":"/api-reference/endpoints/features/update-feature"},{"openapi":"put /v1/features/{code}/archive","title":"Archive feature","href":"/api-reference/endpoints/features/archive-feature"},{"openapi":"put /v1/features/{code}/unarchive","title":"Unarchive feature","href":"/api-reference/endpoints/features/unarchive-feature"},{"openapi":"delete /v1/features/{code}","title":"Delete feature","href":"/api-reference/endpoints/features/delete-feature"}]},{"group":"Price books","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/price-books/{id}","title":"Get price book","href":"/api-reference/endpoints/price-books/get-price-book"},{"openapi":"get /v1/price-books","title":"List price books","href":"/api-reference/endpoints/price-books/list-price-books"},{"openapi":"post /v1/price-books","title":"Create price book","href":"/api-reference/endpoints/price-books/create-price-book"},{"openapi":"put /v1/price-books/{id}","title":"Update price book","href":"/api-reference/endpoints/price-books/update-price-book"},{"openapi":"post /v1/price-books/{id}/products","title":"Add products to price book","href":"/api-reference/endpoints/price-books/add-products-to-price-book"},{"openapi":"delete /v1/price-books/{id}/products/{productId}","title":"Remove product from price book","href":"/api-reference/endpoints/price-books/remove-product-from-price-book"},{"openapi":"delete /v1/price-books/{id}","title":"Delete price book","href":"/api-reference/endpoints/price-books/delete-price-book"}]},{"group":"Price configurations","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/price-configurations/{id}","title":"Get price configuration","href":"/api-reference/endpoints/price-configurations/get-price-configuration"},{"openapi":"get /v1/price-configurations","title":"List price configurations","href":"/api-reference/endpoints/price-configurations/list-price-configurations"},{"openapi":"post /v1/price-configurations","title":"Create price configuration","href":"/api-reference/endpoints/price-configurations/create-price-configuration"},{"openapi":"put /v1/price-configurations/{id}/prices","title":"Update prices","href":"/api-reference/endpoints/price-configurations/update-prices"},{"openapi":"delete /v1/price-configurations/{id}","title":"Delete price configuration","href":"/api-reference/endpoints/price-configurations/delete-price-configuration"}]},{"group":"Products","icon":"arrow-turn-down-right","expanded":false,"pages":[{"group":"Features","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/products/{id}/features","title":"List product features","href":"/api-reference/endpoints/products->-features/list-product-features"},{"openapi":"put /v1/products/{id}/features/{code}","title":"Set product feature","href":"/api-reference/endpoints/products->-features/set-product-feature"},{"openapi":"delete /v1/products/{id}/features/{code}","title":"Delete product feature","href":"/api-reference/endpoints/products->-features/delete-product-feature"}]},{"openapi":"get /v1/products/{id}","title":"Get product","href":"/api-reference/endpoints/products/get-product"},{"openapi":"get /v1/products","title":"List products","href":"/api-reference/endpoints/products/list-products"},{"openapi":"post /v1/products","title":"Create product","href":"/api-reference/endpoints/products/create-product"},{"openapi":"put /v1/products/{id}","title":"Update product","href":"/api-reference/endpoints/products/update-product"},{"openapi":"put /v1/products/{id}/archive","title":"Archive product","href":"/api-reference/endpoints/products/archive-product"},{"openapi":"put /v1/products/{id}/unarchive","title":"Unarchive product","href":"/api-reference/endpoints/products/unarchive-product"},{"openapi":"delete /v1/products/{id}","title":"Delete product","href":"/api-reference/endpoints/products/delete-product"}]},{"group":"Versioning","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/catalog/versions/draft","title":"Get catalog draft","href":"/api-reference/endpoints/catalog/get-catalog-draft"},{"openapi":"get /v1/catalog/versions/{id}","title":"Get catalog version","href":"/api-reference/endpoints/catalog/get-catalog-version"},{"openapi":"get /v1/catalog/versions","title":"List catalog versions","href":"/api-reference/endpoints/catalog/list-catalog-versions"},{"openapi":"post /v1/catalog/versions/draft","title":"Create catalog draft","href":"/api-reference/endpoints/catalog/create-catalog-draft"},{"openapi":"delete /v1/catalog/versions/draft","title":"Discard catalog draft","href":"/api-reference/endpoints/catalog/discard-catalog-draft"},{"openapi":"get /v1/catalog/export","title":"Export catalog","href":"/api-reference/endpoints/catalog/export-catalog"},{"openapi":"post /v1/catalog/versions/draft/publish","title":"Publish catalog draft","href":"/api-reference/endpoints/catalog/publish-catalog-draft"},{"openapi":"post /v1/catalog/versions/{id}/revert","title":"Revert catalog version","href":"/api-reference/endpoints/catalog/revert-catalog-version"}]}]},{"group":"Custom properties","tag":"4","expanded":false,"pages":[{"openapi":"get /v1/custom-properties","title":"List custom properties","href":"/api-reference/endpoints/custom-properties/list-custom-properties"},{"openapi":"post /v1/custom-properties","title":"Create custom property","href":"/api-reference/endpoints/custom-properties/create-custom-property"},{"openapi":"put /v1/custom-properties/{id}","title":"Update custom property","href":"/api-reference/endpoints/custom-properties/update-custom-property"},{"openapi":"delete /v1/custom-properties/{id}","title":"Delete custom property","href":"/api-reference/endpoints/custom-properties/delete-custom-property"}]},{"group":"Customers","tag":"50","expanded":false,"pages":[{"group":"Address","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/{customerId}/addresses","title":"List addresses","href":"/api-reference/endpoints/customers->-address/list-addresses"},{"openapi":"post /v1/customers/{customerId}/addresses","title":"Create address","href":"/api-reference/endpoints/customers->-address/create-address"},{"openapi":"patch /v1/customers/{customerId}/addresses/{addressId}","title":"Update address","href":"/api-reference/endpoints/customers->-address/update-address"},{"openapi":"delete /v1/customers/{customerId}/addresses/{addressId}","title":"Delete address","href":"/api-reference/endpoints/customers->-address/delete-address"}]},{"group":"Credits","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/{id}/credits/{productId}","title":"Get credit product","href":"/api-reference/endpoints/customers->-credits/get-credit-product"},{"openapi":"get /v1/customers/{id}/credits/{productId}/portal-settings","title":"Get credit portal settings","href":"/api-reference/endpoints/customers->-credits/get-credit-portal-settings"},{"openapi":"get /v1/customers/credits","title":"List all credit products","href":"/api-reference/endpoints/customers->-credits/list-all-credit-products"},{"openapi":"get /v1/customers/{id}/credits","title":"List credit products","href":"/api-reference/endpoints/customers->-credits/list-credit-products"},{"openapi":"get /v1/customers/{id}/credits/{productId}/transactions","title":"List credit transactions","href":"/api-reference/endpoints/customers->-credits/list-credit-transactions"},{"openapi":"post /v1/customers/{id}/credits","title":"Create credit product","href":"/api-reference/endpoints/customers->-credits/create-credit-product"},{"openapi":"post /v1/customers/{id}/credits/{productId}/usage","title":"Create credits usage","href":"/api-reference/endpoints/customers->-credits/create-credits-usage"},{"openapi":"put /v1/customers/{id}/credits/{productId}","title":"Update credit product","href":"/api-reference/endpoints/customers->-credits/update-credit-product"},{"openapi":"patch /v1/customers/{id}/credits/{productId}/transactions/{transactionId}","title":"Update credit topup expiration","href":"/api-reference/endpoints/customers->-credits/update-credit-topup-expiration"},{"openapi":"put /v1/customers/{id}/credits/{productId}/portal-settings","title":"Update credit portal settings","href":"/api-reference/endpoints/customers->-credits/update-credit-portal-settings"},{"openapi":"post /v1/customers/{id}/credits/{productId}/purchase","title":"Purchase credits","href":"/api-reference/endpoints/customers->-credits/purchase-credits"},{"openapi":"post /v1/customers/{id}/credits/{productId}/topup","title":"Topup credits","href":"/api-reference/endpoints/customers->-credits/topup-credits"}]},{"group":"Features","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/{id}/features","title":"Resolve customer features","href":"/api-reference/endpoints/customers->-features/resolve-customer-features"},{"openapi":"put /v1/customers/{id}/features/{code}","title":"Set customer feature","href":"/api-reference/endpoints/customers->-features/set-customer-feature"},{"openapi":"delete /v1/customers/{id}/features/{code}","title":"Delete customer feature","href":"/api-reference/endpoints/customers->-features/delete-customer-feature"}]},{"group":"Lifecycle","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"put /v1/customers/{id}/archive","title":"Archive customer","href":"/api-reference/endpoints/customers/archive-customer"},{"openapi":"put /v1/customers/{id}/unarchive","title":"Unarchive customer","href":"/api-reference/endpoints/customers/unarchive-customer"},{"openapi":"delete /v1/customers/{id}","title":"Delete customer","href":"/api-reference/endpoints/customers/delete-customer"}]},{"group":"Organisations","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/organisations/{id}","title":"Get organisation","href":"/api-reference/endpoints/organisations/get-organisation"},{"openapi":"get /v1/organisations","title":"List organisations","href":"/api-reference/endpoints/organisations/list-organisations"},{"openapi":"patch /v1/organisations/{id}","title":"Patch organisation","href":"/api-reference/endpoints/organisations/patch-organisation"}]},{"group":"Payment methods","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/{id}/payment-methods/{paymentMethodId}","title":"Get payment method","href":"/api-reference/endpoints/customers->-payment-methods/get-payment-method"},{"openapi":"get /v1/customers/{id}/payment-methods","title":"List payment methods","href":"/api-reference/endpoints/customers->-payment-methods/list-payment-methods"},{"openapi":"post /v1/customers/{id}/payment-methods","title":"Create payment method","href":"/api-reference/endpoints/customers->-payment-methods/create-payment-method"},{"openapi":"delete /v1/customers/{id}/payment-methods/{paymentMethodId}","title":"Delete payment method","href":"/api-reference/endpoints/customers->-payment-methods/delete-payment-method"}]},{"group":"Segments","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/segments/{id}","title":"Get segment","href":"/api-reference/endpoints/customers->-segments/get-segment"},{"openapi":"get /v1/customers/segments","title":"List segments","href":"/api-reference/endpoints/customers->-segments/list-segments"},{"openapi":"post /v1/customers/segments","title":"Create segment","href":"/api-reference/endpoints/customers->-segments/create-segment"},{"openapi":"patch /v1/customers/segments/{id}","title":"Update segment","href":"/api-reference/endpoints/customers->-segments/update-segment"},{"openapi":"delete /v1/customers/segments/{id}","title":"Delete segment","href":"/api-reference/endpoints/customers->-segments/delete-segment"}]},{"group":"Shipping","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/{customerId}/shipping","title":"Get shipping destination","href":"/api-reference/endpoints/customers->-shipping/get-shipping-destination"},{"openapi":"put /v1/customers/{customerId}/shipping","title":"Set shipping destination","href":"/api-reference/endpoints/customers->-shipping/set-shipping-destination"}]},{"group":"Usage","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/{id}/usage/{aggregator_id}","title":"Get customer usage for an aggregator","href":"/api-reference/endpoints/customers->-usage/get-customer-usage-for-an-aggregator"},{"openapi":"get /v1/customers/{id}/usage/{aggregator_id}/timeseries","title":"Get customer usage timeseries","href":"/api-reference/endpoints/customers->-usage/get-customer-usage-timeseries"},{"openapi":"get /v1/customers/{id}/usage/{aggregator_id}/events","title":"Get customer usage events","href":"/api-reference/endpoints/customers->-usage/get-customer-usage-events"},{"openapi":"get /v1/customers/{id}/usage","title":"List customer usage","href":"/api-reference/endpoints/customers->-usage/list-customer-usage"}]},{"openapi":"get /v2/customers/{id}","title":"Get customer","href":"/api-reference/endpoints/customers/get-customer"},{"openapi":"get /v1/customers/{id}/portal","title":"Get customer portal","href":"/api-reference/endpoints/customers/get-customer-portal"},{"openapi":"get /v1/customers/{id}/taxes/rates","title":"Get customer tax rates","href":"/api-reference/endpoints/customers/get-customer-tax-rates"},{"openapi":"get /v1/customers/{id}/arr-history","title":"Get customer ARR history","href":"/api-reference/endpoints/customers/get-customer-arr-history"},{"openapi":"get /v1/customers/{id}/valuation","title":"Get customer valuation","href":"/api-reference/endpoints/customers/get-customer-valuation"},{"openapi":"get /v2/customers","title":"List customers","href":"/api-reference/endpoints/customers/list-customers"},{"openapi":"post /v1/customers","title":"Create customer","href":"/api-reference/endpoints/customers/create-customer"},{"openapi":"post /v1/customers/batch","title":"Create customers batch","href":"/api-reference/endpoints/customers/create-customers-batch"},{"openapi":"put /v1/customers/{id}","title":"Update customer","href":"/api-reference/endpoints/customers/update-customer"},{"openapi":"post /v1/customers/providers-bulk-update","title":"Bulk update providers/customers mapping","href":"/api-reference/endpoints/customers/bulk-update-providerscustomers-mapping"}]},{"group":"Files","tag":"4","expanded":false,"pages":[{"openapi":"get /v1/files","title":"List files","href":"/api-reference/endpoints/files/list-files"},{"openapi":"get /v1/files/{id}/download","title":"Download file","href":"/api-reference/endpoints/files/download-file"},{"openapi":"post /v1/files","title":"Create file","href":"/api-reference/endpoints/files/create-file"},{"openapi":"delete /v1/files/{id}","title":"Delete file","href":"/api-reference/endpoints/files/delete-file"}]},{"group":"Integrations","tag":"1","expanded":false,"pages":[{"openapi":"post /v1/integrations/components/token","title":"Create component token","href":"/api-reference/endpoints/integrations/create-component-token"}]},{"group":"Invoicing","tag":"28","expanded":false,"pages":[{"group":"Credit notes","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/invoices/{id}/credit-notes","title":"Create credit note","href":"/api-reference/endpoints/invoices/create-credit-note"},{"openapi":"put /v1/invoices/{id}/allocations","title":"Update credit note allocations","href":"/api-reference/endpoints/invoices/update-credit-note-allocations"}]},{"group":"Documents","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v2/invoices/{id}/download","title":"Download invoice","href":"/api-reference/endpoints/invoices/download-invoice"},{"openapi":"post /v1/invoices/send-email","title":"Send invoice emails","href":"/api-reference/endpoints/invoices/send-invoice-emails"},{"openapi":"post /v1/invoices/{id}/upload","title":"Upload PDF to invoice","href":"/api-reference/endpoints/invoices/upload-pdf-to-invoice"}]},{"group":"Events","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/invoices/{id}/events","title":"List invoice events","href":"/api-reference/endpoints/invoices->-events/list-invoice-events"}]},{"group":"Invoicing entities","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/invoicing-entities/{id}","title":"Get invoicing entity","href":"/api-reference/endpoints/invoicing-entities/get-invoicing-entity"},{"openapi":"get /v1/invoicing-entities","title":"List invoicing entities","href":"/api-reference/endpoints/invoicing-entities/list-invoicing-entities"},{"openapi":"post /v1/invoicing-entities","title":"Create invoicing entity","href":"/api-reference/endpoints/invoicing-entities/create-invoicing-entity"},{"openapi":"put /v1/invoicing-entities/{id}","title":"Update invoicing entity","href":"/api-reference/endpoints/invoicing-entities/update-invoicing-entity"},{"openapi":"delete /v1/invoicing-entities/{id}","title":"Delete invoicing entity","href":"/api-reference/endpoints/invoicing-entities/delete-invoicing-entity"}]},{"group":"Lifecycle","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/invoices/{id}/charge","title":"Charge invoice","href":"/api-reference/endpoints/invoices/charge-invoice"},{"openapi":"post /v1/invoices/{id}/uncollectible","title":"Mark as uncollectible","href":"/api-reference/endpoints/invoices/mark-as-uncollectible"},{"openapi":"post /v1/invoices/{id}/validate","title":"Validate draft invoice","href":"/api-reference/endpoints/invoices/validate-draft-invoice"},{"openapi":"post /v1/invoices/{id}/void","title":"Void invoice","href":"/api-reference/endpoints/invoices/void-invoice"}]},{"group":"Taxes","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/taxes/rates/{id}","title":"Get tax rate","href":"/api-reference/endpoints/taxes/get-tax-rate"},{"openapi":"get /v1/taxes/rates","title":"List tax rates","href":"/api-reference/endpoints/taxes/list-tax-rates"},{"openapi":"post /v1/taxes/rates","title":"Create tax rate","href":"/api-reference/endpoints/taxes/create-tax-rate"},{"openapi":"patch /v1/taxes/rates/{id}","title":"Update tax rate","href":"/api-reference/endpoints/taxes/update-tax-rate"},{"openapi":"delete /v1/taxes/rates/{id}","title":"Delete tax rate","href":"/api-reference/endpoints/taxes/delete-tax-rate"}]},{"group":"Transactions","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/invoices/{id}/transactions","title":"Create transaction","href":"/api-reference/endpoints/invoices->-transactions/create-transaction"},{"openapi":"delete /v1/invoices/{id}/transactions/{transactionId}","title":"Delete transaction","href":"/api-reference/endpoints/invoices->-transactions/delete-transaction"}]},{"openapi":"get /v2/invoices/{id}","title":"Get invoice","description":"Retrieve the details of an existing invoice.","href":"/api-reference/endpoints/invoices/get-invoice"},{"openapi":"get /v2/invoices","title":"List invoices","href":"/api-reference/endpoints/invoices/list-invoices"},{"openapi":"post /v1/invoices","title":"Create invoice","description":"Create a new invoice.","href":"/api-reference/endpoints/invoices/create-invoice"},{"openapi":"post /v2/invoices/batch","title":"Create invoices","href":"/api-reference/endpoints/invoices/create-invoices"},{"openapi":"patch /v1/invoices/{id}","title":"Update invoice","href":"/api-reference/endpoints/invoices/update-invoice"},{"openapi":"delete /v1/invoices/{id}","title":"Delete invoice","href":"/api-reference/endpoints/invoices/delete-invoice"}]},{"group":"OAuth2","tag":"6","expanded":false,"pages":[{"openapi":"get /oauth/userinfo","title":"Get user info","href":"/api-reference/endpoints/oauth2/get-user-info"},{"openapi":"get /oauth/authorize","title":"Authorize","href":"/api-reference/endpoints/oauth2/authorize"},{"openapi":"post /oauth/tokens","title":"Generate tokens","href":"/api-reference/endpoints/oauth2/generate-tokens"},{"openapi":"get /oauth/callback","title":"OAuth callback","href":"/api-reference/endpoints/oauth2/oauth-callback"},{"openapi":"post /oauth/register","title":"Register OAuth client","href":"/api-reference/endpoints/oauth2/register-oauth-client"},{"openapi":"post /oauth/revoke","title":"Revoke token","href":"/api-reference/endpoints/oauth2/revoke-token"}]},{"group":"Quoting","tag":"32","expanded":false,"pages":[{"group":"Approvals","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/quotes/{id}/approvals","title":"Get quote approvals","href":"/api-reference/endpoints/quotes->-approvals/get-quote-approvals"},{"openapi":"post /v1/quotes/{id}/approve","title":"Approve quote","href":"/api-reference/endpoints/quotes->-approvals/approve-quote"}]},{"group":"Documents","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/quotes/{id}/download","title":"Download quote","href":"/api-reference/endpoints/quotes/download-quote"},{"openapi":"get /v1/quotes/{quoteId}/files/{id}/download","title":"Download quote file","href":"/api-reference/endpoints/quotes/download-quote-file"}]},{"group":"Library","icon":"arrow-turn-down-right","expanded":false,"pages":[{"group":"Clauses","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/contracts/clauses/{id}","title":"Get contract clause","href":"/api-reference/endpoints/contracts->-clauses/get-contract-clause"},{"openapi":"get /v1/contracts/clauses","title":"List contract clauses","href":"/api-reference/endpoints/contracts->-clauses/list-contract-clauses"},{"openapi":"post /v1/contracts/clauses","title":"Create contract clause","href":"/api-reference/endpoints/contracts->-clauses/create-contract-clause"},{"openapi":"put /v1/contracts/clauses/{id}","title":"Update contract clause","href":"/api-reference/endpoints/contracts->-clauses/update-contract-clause"},{"openapi":"delete /v1/contracts/clauses/{id}","title":"Delete contract clause","href":"/api-reference/endpoints/contracts->-clauses/delete-contract-clause"}]},{"group":"Contracts","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/contracts/documents/{id}","title":"Get contract document","href":"/api-reference/endpoints/contracts->-documents/get-contract-document"},{"openapi":"get /v1/contracts/documents","title":"List contract documents","href":"/api-reference/endpoints/contracts->-documents/list-contract-documents"},{"openapi":"post /v1/contracts/documents","title":"Create contract document","href":"/api-reference/endpoints/contracts->-documents/create-contract-document"},{"openapi":"post /v1/contracts/documents/{id}/contents","title":"Create contract document content","href":"/api-reference/endpoints/contracts->-documents/create-contract-document-content"},{"openapi":"put /v1/contracts/documents/{id}","title":"Update contract document","href":"/api-reference/endpoints/contracts->-documents/update-contract-document"},{"openapi":"put /v1/contracts/documents/{id}/contents/{contentId}","title":"Update contract document content","href":"/api-reference/endpoints/contracts->-documents/update-contract-document-content"},{"openapi":"delete /v1/contracts/documents/{id}","title":"Delete contract document","href":"/api-reference/endpoints/contracts->-documents/delete-contract-document"},{"openapi":"delete /v1/contracts/documents/{id}/contents/{contentId}","title":"Delete contract document content","href":"/api-reference/endpoints/contracts->-documents/delete-contract-document-content"}]}]},{"group":"Lifecycle","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/quotes/{id}/finalize","title":"Finalize quote","href":"/api-reference/endpoints/quotes/finalize-quote"},{"openapi":"post /v1/quotes/{id}/redraft","title":"Redraft quote","href":"/api-reference/endpoints/quotes/redraft-quote"},{"openapi":"post /v1/quotes/{id}/send","title":"Send quote","href":"/api-reference/endpoints/quotes/send-quote"},{"openapi":"post /v1/quotes/{id}/void","title":"Void quote","href":"/api-reference/endpoints/quotes/void-quote"}]},{"group":"Signatures","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/quotes/{id}/signers","title":"List quote signers","href":"/api-reference/endpoints/quotes/list-quote-signers"},{"openapi":"put /v1/quotes/{id}/signers","title":"Set quote signers","href":"/api-reference/endpoints/quotes/set-quote-signers"},{"openapi":"post /v1/quotes/{id}/sign","title":"Sign quote","href":"/api-reference/endpoints/quotes/sign-quote"}]},{"group":"Templates","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/quotes/templates/{id}","title":"Get quote template","href":"/api-reference/endpoints/quotes->-templates/get-quote-template"},{"openapi":"get /v1/quotes/templates","title":"List quote templates","href":"/api-reference/endpoints/quotes->-templates/list-quote-templates"}]},{"openapi":"get /v1/quotes/{id}","title":"Get quote","href":"/api-reference/endpoints/quotes/get-quote"},{"openapi":"get /v1/quotes/{id}/valuation","title":"Get quote valuation","href":"/api-reference/endpoints/quotes/get-quote-valuation"},{"openapi":"get /v1/quotes","title":"List quotes","href":"/api-reference/endpoints/quotes/list-quotes"},{"openapi":"post /v1/quotes","title":"Create quote","href":"/api-reference/endpoints/quotes/create-quote"},{"openapi":"patch /v1/quotes/{id}","title":"Update quote","href":"/api-reference/endpoints/quotes/update-quote"},{"openapi":"post /v1/quotes/{id}/duplicate","title":"Duplicate quote","href":"/api-reference/endpoints/quotes/duplicate-quote"}]},{"group":"Reports","tag":"5","expanded":false,"pages":[{"group":"Analytics","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/analytics","title":"Get analytics","href":"/api-reference/endpoints/analytics/get-analytics"}]},{"group":"Exports","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/exports/{exportId}","title":"Get export","href":"/api-reference/endpoints/exports/get-export"},{"openapi":"get /v1/exports","title":"List exports","href":"/api-reference/endpoints/exports/list-exports"},{"openapi":"get /v2/exports/{exportId}/download","title":"Download export","href":"/api-reference/endpoints/exports/download-export"},{"openapi":"post /v1/exports","title":"Create export","href":"/api-reference/endpoints/exports/create-export"}]}]},{"group":"Subscriptions","tag":"35","expanded":false,"pages":[{"group":"Billing","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/subscriptions/{id}/estimates","title":"List subscription estimates","href":"/api-reference/endpoints/subscriptions/list-subscription-estimates"},{"openapi":"post /v2/subscriptions/{id}/refresh-seat-products","title":"Refresh seat products","href":"/api-reference/endpoints/subscriptions/refresh-seat-products"},{"openapi":"post /v1/subscriptions/refresh","title":"Refresh subscriptions","href":"/api-reference/endpoints/subscriptions/refresh-subscriptions"}]},{"group":"Changes","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/subscriptions/{id}/update","title":"Create subscription update","href":"/api-reference/endpoints/subscriptions/create-subscription-update"},{"openapi":"post /v1/subscriptions/{id}/update-many","title":"Create subscription updates","href":"/api-reference/endpoints/subscriptions/create-subscription-updates"},{"openapi":"post /v1/subscriptions/{id}/simulate-updates","title":"Simulate subscription updates","href":"/api-reference/endpoints/subscriptions/simulate-subscription-updates"}]},{"group":"Lifecycle","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/subscriptions/{id}/activate","title":"Activate subscription","href":"/api-reference/endpoints/subscriptions/activate-subscription"},{"openapi":"post /v1/subscriptions/{id}/cancel","title":"Cancel subscription","href":"/api-reference/endpoints/subscriptions/cancel-subscription"},{"openapi":"post /v1/subscriptions/{id}/pause","title":"Pause subscription","href":"/api-reference/endpoints/subscriptions/pause-subscription"},{"openapi":"get /v1/subscriptions/{id}/preview-timeline","title":"Preview subscription timeline","href":"/api-reference/endpoints/subscriptions/preview-subscription-timeline"},{"openapi":"post /v1/subscriptions/{id}/reactivate","title":"Reactivate subscription","href":"/api-reference/endpoints/subscriptions/reactivate-subscription"},{"openapi":"post /v1/subscriptions/{id}/reinstate","title":"Reinstate subscription","href":"/api-reference/endpoints/subscriptions/reinstate-subscription"},{"openapi":"post /v1/subscriptions/{id}/renew","title":"Renew subscription","href":"/api-reference/endpoints/subscriptions/renew-subscription"}]},{"group":"Phases","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v2/subscriptions/{id}/phases/{phaseId}","title":"Get subscription phase","href":"/api-reference/endpoints/subscriptions->-phases/get-subscription-phase"},{"openapi":"get /v2/subscriptions/{id}/phases","title":"List subscription phases","href":"/api-reference/endpoints/subscriptions->-phases/list-subscription-phases"},{"openapi":"post /v2/subscriptions/{id}/next-phase","title":"Transition subscription to next phase","href":"/api-reference/endpoints/subscriptions->-phases/transition-subscription-to-next-phase"}]},{"group":"Templates","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/subscriptions/templates/{id}","title":"Get subscription template","href":"/api-reference/endpoints/subscriptions->-templates/get-subscription-template"},{"openapi":"get /v1/subscriptions/templates","title":"List subscription templates","href":"/api-reference/endpoints/subscriptions->-templates/list-subscription-templates"},{"openapi":"post /v1/subscriptions/templates","title":"Create subscription template","href":"/api-reference/endpoints/subscriptions->-templates/create-subscription-template"},{"openapi":"post /v1/subscriptions/templates/{id}/configurations","title":"Create subscription template configuration","href":"/api-reference/endpoints/subscriptions->-templates/create-subscription-template-configuration"},{"openapi":"patch /v1/subscriptions/templates/{id}","title":"Update subscription template","href":"/api-reference/endpoints/subscriptions->-templates/update-subscription-template"},{"openapi":"put /v1/subscriptions/templates/{templateId}/configurations/{id}","title":"Update subscription template configuration","href":"/api-reference/endpoints/subscriptions->-templates/update-subscription-template-configuration"},{"openapi":"delete /v1/subscriptions/templates/{id}","title":"Delete subscription template","href":"/api-reference/endpoints/subscriptions->-templates/delete-subscription-template"},{"openapi":"delete /v1/subscriptions/templates/{templateId}/configurations/{id}","title":"Delete subscription template configuration","href":"/api-reference/endpoints/subscriptions->-templates/delete-subscription-template-configuration"}]},{"group":"Transitions","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v2/subscriptions/transitions/{id}","title":"Get subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/get-subscription-transition"},{"openapi":"get /v2/subscriptions/transitions","title":"List subscription transitions","href":"/api-reference/endpoints/subscriptions->-transitions/list-subscription-transitions"},{"openapi":"post /v2/subscriptions/transitions","title":"Create subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/create-subscription-transition"},{"openapi":"post /v2/subscriptions/transitions/{id}/cancel","title":"Cancel subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/cancel-subscription-transition"},{"openapi":"post /v2/subscriptions/transitions/preview","title":"Preview subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/preview-subscription-transition"}]},{"openapi":"get /v2/subscriptions/{id}","title":"Get subscription","href":"/api-reference/endpoints/subscriptions/get-subscription"},{"openapi":"get /v1/subscriptions/{id}/arr-history","title":"Get subscription ARR history","href":"/api-reference/endpoints/subscriptions/get-subscription-arr-history"},{"openapi":"get /v1/subscriptions/{id}/valuation","title":"Get subscription valuation","href":"/api-reference/endpoints/subscriptions/get-subscription-valuation"},{"openapi":"get /v2/subscriptions","title":"List subscriptions","href":"/api-reference/endpoints/subscriptions/list-subscriptions"},{"openapi":"post /v2/subscriptions","title":"Create subscription","href":"/api-reference/endpoints/subscriptions/create-subscription"},{"openapi":"put /v2/subscriptions/{id}","title":"Update subscription","href":"/api-reference/endpoints/subscriptions/update-subscription"}]},{"group":"Third-party apps","tag":"4","expanded":false,"pages":[{"openapi":"get /v1/apps","title":"List apps","href":"/api-reference/endpoints/third-party-apps/list-apps"},{"openapi":"post /v1/apps","title":"Create app","href":"/api-reference/endpoints/third-party-apps/create-app"},{"openapi":"put /v1/apps/{id}","title":"Update app","href":"/api-reference/endpoints/third-party-apps/update-app"},{"openapi":"delete /v1/apps/{id}","title":"Delete app","href":"/api-reference/endpoints/third-party-apps/delete-app"}]},{"group":"Transactions","tag":"9","expanded":false,"pages":[{"group":"Bank accounts","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/bank-accounts/{id}","title":"Get bank account","href":"/api-reference/endpoints/bank-accounts/get-bank-account"},{"openapi":"get /v1/bank-accounts","title":"List bank accounts","href":"/api-reference/endpoints/bank-accounts/list-bank-accounts"},{"openapi":"get /v1/bank-accounts/{id}/transactions","title":"List bank transactions","href":"/api-reference/endpoints/bank-accounts/list-bank-transactions"}]},{"openapi":"post /v1/payments","title":"Create payment","href":"/api-reference/endpoints/payments/create-payment"},{"openapi":"get /v1/transactions/{id}","title":"Get transaction","href":"/api-reference/endpoints/transactions/get-transaction"},{"openapi":"get /v1/transactions","title":"List transactions","href":"/api-reference/endpoints/transactions/list-transactions"},{"openapi":"post /v1/transactions","title":"Create transaction","href":"/api-reference/endpoints/transactions/create-transaction"},{"openapi":"post /v1/transactions/{id}/refund","title":"Refund transaction","href":"/api-reference/endpoints/transactions/refund-transaction"},{"openapi":"delete /v1/transactions/{id}","title":"Delete transaction","href":"/api-reference/endpoints/transactions/delete-transaction"}]},{"group":"Usage","tag":"13","expanded":false,"pages":[{"group":"Aggregators","icon":"arrow-turn-down-right","expanded":false,"pages":[{"group":"Usage","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/aggregators/{id}/usage","title":"Get aggregator usage","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage"},{"openapi":"get /v1/aggregators/{id}/usage/timeseries","title":"Get aggregator usage timeseries","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-timeseries"},{"openapi":"get /v1/aggregators/{id}/usage/group-by-customer","title":"Get aggregator usage grouped by customer","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-grouped-by-customer"},{"openapi":"get /v1/aggregators/{id}/usage/events","title":"Get aggregator usage events","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-events"}]},{"openapi":"get /v1/aggregators/{id}","title":"Get aggregator","href":"/api-reference/endpoints/aggregators/get-aggregator"},{"openapi":"get /v1/aggregators","title":"List aggregators","href":"/api-reference/endpoints/aggregators/list-aggregators"},{"openapi":"post /v1/aggregators","title":"Create aggregator","href":"/api-reference/endpoints/aggregators/create-aggregator"},{"openapi":"put /v1/aggregators/{id}","title":"Update aggregator","href":"/api-reference/endpoints/aggregators/update-aggregator"},{"openapi":"delete /v1/aggregators/{id}","title":"Delete aggregator","href":"/api-reference/endpoints/aggregators/delete-aggregator"}]},{"group":"Billable events","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/events","title":"Get events","href":"/api-reference/endpoints/billable-events/get-events"},{"openapi":"post /v1/events","title":"Ingest billable event","href":"/api-reference/endpoints/billable-events/ingest-billable-event"},{"openapi":"post /v1/events/batch","title":"Ingest billable events","href":"/api-reference/endpoints/billable-events/ingest-billable-events"},{"openapi":"delete /v1/events","title":"Delete billable events","href":"/api-reference/endpoints/billable-events/delete-billable-events"}]}]},{"group":"Users","tag":"4","expanded":false,"pages":[{"openapi":"get /v1/users/{id}","title":"Get user","href":"/api-reference/endpoints/users/get-user"},{"openapi":"get /v1/users","title":"List users","href":"/api-reference/endpoints/users/list-users"},{"openapi":"get /v1/users/roles/{id}","title":"Get user role","href":"/api-reference/endpoints/users->-roles/get-user-role"},{"openapi":"get /v1/users/roles","title":"List user roles","href":"/api-reference/endpoints/users->-roles/list-user-roles"}]},{"group":"Wallets","tag":"9","expanded":false,"pages":[{"openapi":"get /v1/wallets/settings","title":"Get wallet settings","href":"/api-reference/endpoints/wallets/get-wallet-settings"},{"openapi":"get /v1/wallets/{id}","title":"Get wallet","href":"/api-reference/endpoints/wallets/get-wallet"},{"openapi":"get /v2/wallets","title":"List wallets","href":"/api-reference/endpoints/wallets/list-wallets"},{"openapi":"get /v1/wallets/{id}/transactions","title":"List wallet transactions","href":"/api-reference/endpoints/wallets/list-wallet-transactions"},{"openapi":"post /v1/wallets","title":"Create wallet","href":"/api-reference/endpoints/wallets/create-wallet"},{"openapi":"patch /v1/wallets/settings","title":"Update wallet settings","href":"/api-reference/endpoints/wallets/update-wallet-settings"},{"openapi":"put /v1/wallets/{id}","title":"Update wallet","href":"/api-reference/endpoints/wallets/update-wallet"},{"openapi":"post /v1/wallets/{id}/load","title":"Load wallet","href":"/api-reference/endpoints/wallets/load-wallet"},{"openapi":"post /v1/wallets/{id}/transactions/{transactionId}/revert","title":"Revert wallet load","href":"/api-reference/endpoints/wallets/revert-wallet-load"}]},{"group":"Webhooks","tag":"6","expanded":false,"pages":[{"openapi":"get /v1/webhooks/endpoints/{id}","title":"Get webhook endpoint","href":"/api-reference/endpoints/webhooks/get-webhook-endpoint"},{"openapi":"get /v1/webhooks/endpoints","title":"List webhook endpoints","href":"/api-reference/endpoints/webhooks/list-webhook-endpoints"},{"openapi":"get /v1/webhooks/messages","title":"List webhook messages","href":"/api-reference/endpoints/webhooks/list-webhook-messages"},{"openapi":"post /v1/webhooks/endpoints","title":"Create webhook endpoint","href":"/api-reference/endpoints/webhooks/create-webhook-endpoint"},{"openapi":"put /v1/webhooks/endpoints/{id}","title":"Update webhook endpoint","href":"/api-reference/endpoints/webhooks/update-webhook-endpoint"},{"openapi":"delete /v1/webhooks/endpoints/{id}","title":"Delete webhook endpoint","href":"/api-reference/endpoints/webhooks/delete-webhook-endpoint"}]},{"group":"Workspaces","tag":"2","expanded":false,"pages":[{"openapi":"get /v1/companies","title":"List companies","href":"/api-reference/endpoints/companies/list-companies"},{"openapi":"post /v1/companies","title":"Create company","href":"/api-reference/endpoints/companies/create-company"}]}]}]},{"tab":"Guides","icon":"list-check","pages":[{"title":"Guides","href":"/guides/importing-historical-data"}]},{"tab":"Integrations","icon":"link","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Changelog","icon":"bullhorn","pages":[{"title":"Changelog","href":"/changelog/2026-10"}]}]},"basePath":"","title":"List invoices - Hyperline","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-CWFqNdGh.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js","Markdown-BnvucbFu.js","dist-D7YyC486.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-D1I8TPjt.js"]}