Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Sequence","colors":{"primary":"#716FFF","light":"#716FFF","dark":"#716FFF"},"logo":{"light":"https://mintcdn.com/sequence/bptUiZLY1oEfBaTZ/logo/light.svg?fit=max\u0026auto=format\u0026n=bptUiZLY1oEfBaTZ\u0026q=85\u0026s=02adc18f83942b8bdc86ec2b67937e1a","dark":"https://mintcdn.com/sequence/bptUiZLY1oEfBaTZ/logo/dark.svg?fit=max\u0026auto=format\u0026n=bptUiZLY1oEfBaTZ\u0026q=85\u0026s=38182050e1a27d88e9d34b686c985f32"},"favicon":"https://mintcdn.com/sequence/mEkhIlLyJGyDgjJd/favicon.png?fit=max\u0026auto=format\u0026n=mEkhIlLyJGyDgjJd\u0026q=85\u0026s=aebbf4110c663663a51501b506edfcdc","api":{"mdx":{"server":["https://eu.sequencehq.com/api","https://sandbox.sequencehq.com/api"]}},"navbar":{"links":[{"href":"https://dashboard.sequencehq.com","label":"Sign in"}],"primary":{"type":"button","label":"Request Access","href":"https://access.sequencehq.com/"}},"footer":{"socials":{"twitter":"https://twitter.com/SequenceHQ_","github":"https://github.com/sequencehq","linkedin":"https://www.linkedin.com/company/sequence-hq"}},"integrations":{"koala":{"publicApiKey":"pk_c9f1d1603102eb7e1c3a4f6922a45f72991b"},"plausible":{"domain":"sequencehq.com"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Speak to an expert","icon":"message-check","href":"https://access.sequencehq.com/"},{"anchor":"Changelog","icon":"bolt","href":"https://www.sequencehq.com/changelog"},{"anchor":"Blog","icon":"rss","href":"https://www.sequencehq.com/blog"},{"anchor":"Principles","icon":"bookmark","href":"https://www.sequencehq.com/principles"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sequence","hasAudioNarration":false,"actualSubdomain":"sequence","customDomains":["docs.sequencehq.com"],"gitSource":{"type":"github","owner":"sequencehq","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae9e784c43360bf5940256f","collectionId":"a9d5f5f7-df45-4ebd-b8bf-f3cb3add0ae2","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae9e784c43360bf5940256f"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae9ea42eceed668c026a18b","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":388},{"language":"default","tag":"Version 2024-07-30","count":188},{"language":"default","tag":"Latest Live API","count":188},{"language":"default","tag":"Invoices","count":161},{"language":"default","tag":"Guides","count":134},{"language":"default","tag":"Billing","count":65},{"language":"default","tag":"Connectors","count":44},{"language":"default","tag":"Customer","count":38},{"language":"default","tag":"Collections","count":36},{"language":"default","tag":"Usage","count":34}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"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":"llms-txt-v2","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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"reference/2024-07-30/invoices/list-all-credit-notes","slug":"/reference/2024-07-30/invoices/list-all-credit-notes","pageMetadata":{"openapi":"invoices.2024-07-30.product.live GET /credit-notes","title":"List all Credit Notes","description":"List all Credit Notes for this Sequence account","href":"/reference/2024-07-30/invoices/list-all-credit-notes"},"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: \"List all Credit Notes for this Sequence account\"\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":"invoices.2024-07-30.product.live GET /credit-notes","title":"List all Credit Notes","description":"List all Credit Notes for this Sequence account","href":"/reference/2024-07-30/invoices/list-all-credit-notes"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Credit Notes"],"summary":"List all Credit Notes","description":"List all Credit Notes for this Sequence account","operationId":"getCreditNotes","parameters":["419fa584-34fe-4821-b620-3f67e79c3a4e","3c3cac03-7012-4f3a-ad62-087847d01641","8b5ed527-12b0-43c7-82b3-443e198d0101","0db8a55a-3281-4bd8-8f82-7fcacbc4e7dc","e5529c9a-0b53-4f3c-9fe2-5d08248cda61","654945cd-f5ea-4332-901c-2809dae87773","7d8540c1-d0d5-4508-8097-595d9e0c4622","840286ac-4cdb-4af2-8960-3c8f045969ff","28e59e29-07f5-4867-98ca-791693c2a30b","4b27b5df-94b8-4f57-a047-1307be905421","ef1f7556-bb0c-4645-b22b-e70e4850f7bb","1fe7b47a-3628-42fb-b9bc-5354b7fb1a18"],"responses":{"200":"5b33162f-4186-4298-9b37-4d31b2f851f8","400":"d4657ecf-ff0d-47da-ab8a-19cd52c62867","401":"91d61e0c-0a16-4caf-8457-794f5d8b6539","500":"1739b3e4-0f34-462c-b004-905d1f8de509"},"method":"get","type":"path","servers":[],"security":[],"path":"/credit-notes","baseUrlOptions":["https://eu.sequencehq.com/api","https://sandbox.sequencehq.com/api"],"title":"List all Credit Notes","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"419fa584-34fe-4821-b620-3f67e79c3a4e":{"name":"Authorization","in":"header","description":"Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.","required":true,"schema":{"type":"string","isRequired":true,"description":"Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.","uniqueKey":"","typeLabel":"string"}},"3c3cac03-7012-4f3a-ad62-087847d01641":{"name":"before","in":"query","description":"Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.","required":false,"schema":{"type":"string","isRequired":false,"description":"Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.","uniqueKey":"","typeLabel":"string"}},"8b5ed527-12b0-43c7-82b3-443e198d0101":{"name":"after","in":"query","description":"Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.","required":false,"schema":{"type":"string","isRequired":false,"description":"Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.","uniqueKey":"","typeLabel":"string"}},"0db8a55a-3281-4bd8-8f82-7fcacbc4e7dc":{"name":"limit","in":"query","description":"Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).","required":false,"schema":{"type":"integer","format":"int32","isRequired":false,"description":"Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).","uniqueKey":"","typeLabel":"integer\u003cint32>"}},"e5529c9a-0b53-4f3c-9fe2-5d08248cda61":{"name":"sortOrder","in":"query","description":"Sort order. Default: DESC (descending, most often used for reverse chronological sorting).","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"isRequired":false,"description":"Sort order. Default: DESC (descending, most often used for reverse chronological sorting).","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"654945cd-f5ea-4332-901c-2809dae87773":{"name":"sortBy","in":"query","description":"Sort column. Default: creation time. Options: GROSS_TOTAL, CREDIT_NOTE_NUMBER, STATUS","required":false,"schema":{"type":"string","isRequired":false,"description":"Sort column. Default: creation time. Options: GROSS_TOTAL, CREDIT_NOTE_NUMBER, STATUS","uniqueKey":"","typeLabel":"string"}},"7d8540c1-d0d5-4508-8097-595d9e0c4622":{"name":"creditNoteStatus","in":"query","description":"Filter by credit note status. Options: DRAFT, FINAL, SENT, VOIDED","required":false,"schema":{"type":"string","isRequired":false,"description":"Filter by credit note status. Options: DRAFT, FINAL, SENT, VOIDED","uniqueKey":"","typeLabel":"string"}},"840286ac-4cdb-4af2-8960-3c8f045969ff":{"name":"customerId","in":"query","description":"Filter by customer id.","required":false,"schema":{"type":"string","isRequired":false,"description":"Filter by customer id.","uniqueKey":"","typeLabel":"string"}},"28e59e29-07f5-4867-98ca-791693c2a30b":{"name":"sentBefore","in":"query","description":"Filter by sent date before. Format: yyyy-MM-dd","required":false,"schema":{"type":"string","isRequired":false,"description":"Filter by sent date before. Format: yyyy-MM-dd","uniqueKey":"","typeLabel":"string"}},"4b27b5df-94b8-4f57-a047-1307be905421":{"name":"sentAfter","in":"query","description":"Filter by sent date after. Format: yyyy-MM-dd","required":false,"schema":{"type":"string","isRequired":false,"description":"Filter by sent date after. Format: yyyy-MM-dd","uniqueKey":"","typeLabel":"string"}},"ef1f7556-bb0c-4645-b22b-e70e4850f7bb":{"name":"searchCreditNoteNumber","in":"query","description":"Search credit notes by credit note number (partial, case-insensitive match)","required":false,"schema":{"type":"string","isRequired":false,"description":"Search credit notes by credit note number (partial, case-insensitive match)","uniqueKey":"","typeLabel":"string"}},"1fe7b47a-3628-42fb-b9bc-5354b7fb1a18":{"name":"sequence-version","in":"header","description":"Use this header to select an API version","required":false,"schema":{"type":"string","enum":["2024-07-30"],"isRequired":false,"description":"Use this header to select an API version","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"5b33162f-4186-4298-9b37-4d31b2f851f8":{"description":"OK","content":{"application/json":{"schema":{"required":["items","pagination"],"type":"object","example":{"items":[{"id":"af60cab3-812d-4250-a051-0fb7133a00c7","sequenceAccountId":"68233908-402a-43b4-8952-1c2ab0ef0b25","status":"SENT","invoiceId":"af60cab3-812d-4250-a051-0fb7133a00c7","invoiceNumber":"INV00001","billingScheduleId":"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95","currency":"GBP","issueDate":"2022-09-15","billingPeriodStart":"2022-10-01T00:00:00Z","billingPeriodEnd":"2022-10-30T00:00:00Z","creditNoteNumber":"CN00001","purchaseOrderNumber":"PO123","customerId":"61b083e0-1faa-47ca-9aeb-6205da8f6c47","customerEmails":["customer@example.com","customer.alias@example.com"],"customerLegalCompanyName":"Facebook","customerBillingAddress":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"customerShippingAddress":{"line1":"742 Evergreen Terrace","town":"Springfield","state":"CA","postcode":"12345","country":"US"},"memo":"Thanks","totalTax":"2.50","netTotal":"51.20","grossTotal":"101.23","metadata":[{"key":"example-label","value":"label-value"}],"customerTaxId":"TAX123","linkedServices":[{"externalId":"123","externalService":"Xero","syncTime":"2022-06-28T16:47:00Z","externalUrl":"https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"}],"applicationStatus":"PARTIALLY_APPLIED","balance":"51.23","balanceVersion":3,"applications":[{"invoiceId":"af60cab3-812d-4250-a051-0fb7133a00c7","invoiceNumber":"INV00001","amount":"50.00","appliedAt":"2022-10-14T12:34:56Z"}],"merchantDetails":{"address":{"line1":"The White House","line2":"1600 Pennsylvania Avenue","town":"Washington, D.C.","state":"CA","postcode":"20500","country":"US"},"phoneNumber":"0800001066","email":"donald@example.com","taxId":"TAX60","iban":"GB33BUKB20201555555555","ukAccountDetails":{"sortCode":"000000","accountNumber":"12345678"},"usAchDetails":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789"},"usWireDetails":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789","swiftCode":"CHASUS33","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"}},"caBankAccountDetails":{"transitNumber":"123","institutionNumber":"12345","accountNumber":"1234567"},"canadianInternationalDestination":{"legalName":"John Doe","accountNumber":"12345678","transitNumber":"12345","bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"institutionNumber":"123","swiftCode":"CHASUS33","intermediaryBank":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"}},"australianDestination":{"legalName":"John Doe","accountNumber":"12345678","swiftCode":"CHASUS33","bsb":"123456"},"swedishBankgiroDestination":{"bankgiroNumber":"123-4567","accountName":"12345678"},"logoUrl":"logo","legalCompanyName":"The Merchant","primaryColour":"#000000","customFields":[{"key":"example-label","value":"label-value"}],"includeBeneficiaryAddressInPaymentDetails":true},"settings":{"generateCashCreditGrant":"ENABLED"},"accountingDate":"2022-09-30"}],"pagination":{"after":"ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==","before":"NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND","totalResultSize":100}},"properties":{"items":{"type":"array","description":"CreditNotes","example":[{"id":"af60cab3-812d-4250-a051-0fb7133a00c7","sequenceAccountId":"68233908-402a-43b4-8952-1c2ab0ef0b25","status":"SENT","invoiceId":"af60cab3-812d-4250-a051-0fb7133a00c7","invoiceNumber":"INV00001","billingScheduleId":"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95","currency":"GBP","issueDate":"2022-09-15","billingPeriodStart":"2022-10-01T00:00:00Z","billingPeriodEnd":"2022-10-30T00:00:00Z","creditNoteNumber":"CN00001","purchaseOrderNumber":"PO123","customerId":"61b083e0-1faa-47ca-9aeb-6205da8f6c47","customerEmails":["customer@example.com","customer.alias@example.com"],"customerLegalCompanyName":"Facebook","customerBillingAddress":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"customerShippingAddress":{"line1":"742 Evergreen Terrace","town":"Springfield","state":"CA","postcode":"12345","country":"US"},"memo":"Thanks","totalTax":"2.50","netTotal":"51.20","grossTotal":"101.23","metadata":[{"key":"example-label","value":"label-value"}],"customerTaxId":"TAX123","linkedServices":[{"externalId":"123","externalService":"Xero","syncTime":"2022-06-28T16:47:00Z","externalUrl":"https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"}],"applicationStatus":"PARTIALLY_APPLIED","balance":"51.23","balanceVersion":3,"applications":[{"invoiceId":"af60cab3-812d-4250-a051-0fb7133a00c7","invoiceNumber":"INV00001","amount":"50.00","appliedAt":"2022-10-14T12:34:56Z"}],"merchantDetails":{"address":{"line1":"The White House","line2":"1600 Pennsylvania Avenue","town":"Washington, D.C.","state":"CA","postcode":"20500","country":"US"},"phoneNumber":"0800001066","email":"donald@example.com","taxId":"TAX60","iban":"GB33BUKB20201555555555","ukAccountDetails":{"sortCode":"000000","accountNumber":"12345678"},"usAchDetails":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789"},"usWireDetails":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789","swiftCode":"CHASUS33","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"}},"caBankAccountDetails":{"transitNumber":"123","institutionNumber":"12345","accountNumber":"1234567"},"canadianInternationalDestination":{"legalName":"John Doe","accountNumber":"12345678","transitNumber":"12345","bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"institutionNumber":"123","swiftCode":"CHASUS33","intermediaryBank":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"}},"australianDestination":{"legalName":"John Doe","accountNumber":"12345678","swiftCode":"CHASUS33","bsb":"123456"},"swedishBankgiroDestination":{"bankgiroNumber":"123-4567","accountName":"12345678"},"logoUrl":"logo","legalCompanyName":"The Merchant","primaryColour":"#000000","customFields":[{"key":"example-label","value":"label-value"}],"includeBeneficiaryAddressInPaymentDetails":true},"settings":{"generateCashCreditGrant":"ENABLED"},"accountingDate":"2022-09-30"}],"items":{"required":["applications","currency","customerBillingAddress","customerEmails","customerId","customerLegalCompanyName","customerShippingAddress","grossTotal","id","linkedServices","metadata","netTotal","sequenceAccountId","settings","status","totalTax"],"type":"object","example":{"id":"af60cab3-812d-4250-a051-0fb7133a00c7","sequenceAccountId":"68233908-402a-43b4-8952-1c2ab0ef0b25","status":"SENT","invoiceId":"af60cab3-812d-4250-a051-0fb7133a00c7","invoiceNumber":"INV00001","billingScheduleId":"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95","currency":"GBP","issueDate":"2022-09-15","billingPeriodStart":"2022-10-01T00:00:00Z","billingPeriodEnd":"2022-10-30T00:00:00Z","creditNoteNumber":"CN00001","purchaseOrderNumber":"PO123","customerId":"61b083e0-1faa-47ca-9aeb-6205da8f6c47","customerEmails":["customer@example.com","customer.alias@example.com"],"customerLegalCompanyName":"Facebook","customerBillingAddress":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"customerShippingAddress":{"line1":"742 Evergreen Terrace","town":"Springfield","state":"CA","postcode":"12345","country":"US"},"memo":"Thanks","totalTax":"2.50","netTotal":"51.20","grossTotal":"101.23","metadata":[{"key":"example-label","value":"label-value"}],"customerTaxId":"TAX123","linkedServices":[{"externalId":"123","externalService":"Xero","syncTime":"2022-06-28T16:47:00Z","externalUrl":"https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"}],"applicationStatus":"PARTIALLY_APPLIED","balance":"51.23","balanceVersion":3,"applications":[{"invoiceId":"af60cab3-812d-4250-a051-0fb7133a00c7","invoiceNumber":"INV00001","amount":"50.00","appliedAt":"2022-10-14T12:34:56Z"}],"merchantDetails":{"address":{"line1":"The White House","line2":"1600 Pennsylvania Avenue","town":"Washington, D.C.","state":"CA","postcode":"20500","country":"US"},"phoneNumber":"0800001066","email":"donald@example.com","taxId":"TAX60","iban":"GB33BUKB20201555555555","ukAccountDetails":{"sortCode":"000000","accountNumber":"12345678"},"usAchDetails":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789"},"usWireDetails":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789","swiftCode":"CHASUS33","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"}},"caBankAccountDetails":{"transitNumber":"123","institutionNumber":"12345","accountNumber":"1234567"},"canadianInternationalDestination":{"legalName":"John Doe","accountNumber":"12345678","transitNumber":"12345","bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"institutionNumber":"123","swiftCode":"CHASUS33","intermediaryBank":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"}},"australianDestination":{"legalName":"John Doe","accountNumber":"12345678","swiftCode":"CHASUS33","bsb":"123456"},"swedishBankgiroDestination":{"bankgiroNumber":"123-4567","accountName":"12345678"},"logoUrl":"logo","legalCompanyName":"The Merchant","primaryColour":"#000000","customFields":[{"key":"example-label","value":"label-value"}],"includeBeneficiaryAddressInPaymentDetails":true},"settings":{"generateCashCreditGrant":"ENABLED"},"accountingDate":"2022-09-30"},"properties":{"id":{"type":"string","description":"Credit Note ID","example":"af60cab3-812d-4250-a051-0fb7133a00c7","isRequired":true,"uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string"},"sequenceAccountId":{"type":"string","description":"Sequence Account ID","example":"68233908-402a-43b4-8952-1c2ab0ef0b25","isRequired":true,"uniqueKey":"\\items.items.[INDEX].sequenceAccountId","typeLabel":"string"},"status":{"type":"string","example":"SENT","enum":["DRAFT","FINAL","IN_PROGRESS","SENT","VOIDED"],"description":"Credit Note status","isRequired":true,"uniqueKey":"\\items.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","example":"GBP","enum":["AED","ARS","AUD","BRL","BGN","CAD","CHF","CLP","CNY","COP","CZK","DKK","EGP","EUR","GBP","HKD","ILS","INR","ISK","JPY","KRW","MXN","NOK","NZD","PLN","SAR","SEK","SGD","THB","USD","UYU","ZAR"],"description":"Credit Note currency","isRequired":true,"uniqueKey":"\\items.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"customerId":{"type":"string","description":"The ID of the Customer this Credit Note is linked to","example":"61b083e0-1faa-47ca-9aeb-6205da8f6c47","isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerId","typeLabel":"string"},"customerEmails":{"type":"array","description":"Customer's email addresses, used for sending the Credit Note if provided","example":["customer@example.com","customer.alias@example.com"],"items":{"type":"string","uniqueKey":"\\items.items.[INDEX].customerEmails.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerEmails","typeLabel":"string[]"},"customerLegalCompanyName":{"type":"string","description":"Customer's legal company name","example":"Facebook","isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerLegalCompanyName","typeLabel":"string"},"customerBillingAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1","isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerBillingAddress.line1","typeLabel":"string"},"town":{"type":"string","description":"Town or city","example":"Yemen","isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerBillingAddress.town","typeLabel":"string"},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE","isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerBillingAddress.postcode","typeLabel":"string"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerBillingAddress.country","typeLabel":"enum\u003cstring>"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road","uniqueKey":"\\items.items.[INDEX].customerBillingAddress.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2","example":"15 Yemen Road","uniqueKey":"\\items.items.[INDEX].customerBillingAddress.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].customerBillingAddress.line2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"\\items.items.[INDEX].customerBillingAddress.state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"\\items.items.[INDEX].customerBillingAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].customerBillingAddress.state","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerBillingAddress","typeLabel":"object"},"customerShippingAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1","isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerShippingAddress.line1","typeLabel":"string"},"town":{"type":"string","description":"Town or city","example":"Yemen","isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerShippingAddress.town","typeLabel":"string"},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE","isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerShippingAddress.postcode","typeLabel":"string"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerShippingAddress.country","typeLabel":"enum\u003cstring>"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road","uniqueKey":"\\items.items.[INDEX].customerShippingAddress.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2","example":"15 Yemen Road","uniqueKey":"\\items.items.[INDEX].customerShippingAddress.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].customerShippingAddress.line2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"\\items.items.[INDEX].customerShippingAddress.state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"\\items.items.[INDEX].customerShippingAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].customerShippingAddress.state","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].customerShippingAddress","typeLabel":"object"},"totalTax":{"type":"string","description":"Total tax, in decimal format of the Credit Note's currency","example":"2.50","isRequired":true,"uniqueKey":"\\items.items.[INDEX].totalTax","typeLabel":"string"},"netTotal":{"type":"string","description":"Net total, in decimal format of the Credit Note's currency","example":"51.20","isRequired":true,"uniqueKey":"\\items.items.[INDEX].netTotal","typeLabel":"string"},"grossTotal":{"type":"string","description":"Gross total, in decimal format of the Invoice's currency","example":"101.23","isRequired":true,"uniqueKey":"\\items.items.[INDEX].grossTotal","typeLabel":"string"},"metadata":{"type":"array","description":"Mapping of key-value pairs to attach to the Credit Note. These are not interpreted by Sequence; they are present for your use alone.","example":[{"key":"example-label","value":"label-value"}],"items":{"required":["key","value"],"type":"object","example":{"key":"example-label","value":"label-value"},"properties":{"key":{"type":"string","example":"example-label","isRequired":true,"uniqueKey":"\\items.items.[INDEX].metadata.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","example":"label-value","isRequired":true,"uniqueKey":"\\items.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].metadata","typeLabel":"object[]"},"linkedServices":{"type":"array","description":"External services which are linked to this credit note","example":[{"externalId":"123","externalService":"Xero","syncTime":"2022-06-28T16:47:00Z","externalUrl":"https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"}],"items":{"required":["externalId","externalService","syncTime"],"type":"object","example":{"externalId":"123","externalService":"Xero","syncTime":"2022-06-28T16:47:00Z","externalUrl":"https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"},"properties":{"externalId":{"type":"string","description":"The ID of the related entity in external system","example":"123","isRequired":true,"uniqueKey":"\\items.items.[INDEX].linkedServices.items.[INDEX].externalId","typeLabel":"string"},"externalService":{"type":"string","example":"Xero","enum":["Amazon_Redshift","GoCardless","Google_BigQuery","Google_Sheets","HubSpot","NetSuite","QuickBooks_Online","Salesforce","Slack","Snowflake","Stripe","Xero","Avalara","Anrok","Attio","Numeral","Rillet","Sphere"],"description":"The connected service","isRequired":true,"uniqueKey":"\\items.items.[INDEX].linkedServices.items.[INDEX].externalService","typeLabel":"enum\u003cstring>"},"syncTime":{"type":"string","description":"The time that this was synced from the connected integration","example":"2022-06-28T16:47:00Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].linkedServices.items.[INDEX].syncTime","typeLabel":"string"},"externalUrl":{"oneOf":[{"type":"string","description":"External URL","example":"https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504","uniqueKey":"\\items.items.[INDEX].linkedServices.items.[INDEX].externalUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"External URL","example":"https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504","uniqueKey":"\\items.items.[INDEX].linkedServices.items.[INDEX].externalUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].linkedServices.items.[INDEX].externalUrl","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].linkedServices.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].linkedServices","typeLabel":"object[]"},"applications":{"type":"array","description":"Invoices this Credit Note has been applied to, each with the amount applied and when. Empty when the Credit Note has not been applied to any invoice","example":[{"invoiceId":"af60cab3-812d-4250-a051-0fb7133a00c7","invoiceNumber":"INV00001","amount":"50.00","appliedAt":"2022-10-14T12:34:56Z"}],"items":{"required":["amount","appliedAt","invoiceId"],"type":"object","example":{"invoiceId":"af60cab3-812d-4250-a051-0fb7133a00c7","invoiceNumber":"INV00001","amount":"50.00","appliedAt":"2022-10-14T12:34:56Z"},"properties":{"invoiceId":{"type":"string","description":"ID of the invoice the credit was applied to","example":"af60cab3-812d-4250-a051-0fb7133a00c7","isRequired":true,"uniqueKey":"\\items.items.[INDEX].applications.items.[INDEX].invoiceId","typeLabel":"string"},"amount":{"type":"string","description":"Amount applied, in decimal format of the Credit Note's currency","example":"50.00","isRequired":true,"uniqueKey":"\\items.items.[INDEX].applications.items.[INDEX].amount","typeLabel":"string"},"appliedAt":{"type":"string","description":"When the credit was applied","example":"2022-10-14T12:34:56Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].applications.items.[INDEX].appliedAt","typeLabel":"string"},"invoiceNumber":{"oneOf":[{"type":"string","description":"Invoice number of the invoice the credit was applied to, when available","example":"INV00001","uniqueKey":"\\items.items.[INDEX].applications.items.[INDEX].invoiceNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Invoice number of the invoice the credit was applied to, when available","example":"INV00001","uniqueKey":"\\items.items.[INDEX].applications.items.[INDEX].invoiceNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].applications.items.[INDEX].invoiceNumber","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].applications.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].applications","typeLabel":"object[]"},"settings":{"required":["generateCashCreditGrant"],"type":"object","description":"Credit note settings","example":{"generateCashCreditGrant":"ENABLED"},"properties":{"generateCashCreditGrant":{"type":"string","example":"ENABLED","enum":["ENABLED","DISABLED"],"description":"Whether to generate a cash credit grant when sending this credit note","isRequired":true,"uniqueKey":"\\items.items.[INDEX].settings.generateCashCreditGrant","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].settings","typeLabel":"object"},"invoiceId":{"oneOf":[{"type":"string","description":"Invoice ID","example":"af60cab3-812d-4250-a051-0fb7133a00c7","uniqueKey":"\\items.items.[INDEX].invoiceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Invoice ID","example":"af60cab3-812d-4250-a051-0fb7133a00c7","uniqueKey":"\\items.items.[INDEX].invoiceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].invoiceId","typeLabel":"string | null"},"invoiceNumber":{"oneOf":[{"type":"string","description":"Invoice Number","example":"INV00001","uniqueKey":"\\items.items.[INDEX].invoiceNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Invoice Number","example":"INV00001","uniqueKey":"\\items.items.[INDEX].invoiceNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].invoiceNumber","typeLabel":"string | null"},"billingScheduleId":{"oneOf":[{"type":"string","description":"Subscription ID","example":"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95","uniqueKey":"\\items.items.[INDEX].billingScheduleId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Subscription ID","example":"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95","uniqueKey":"\\items.items.[INDEX].billingScheduleId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].billingScheduleId","typeLabel":"string | null"},"issueDate":{"oneOf":[{"type":"string","description":"Issue date","example":"2022-09-15","uniqueKey":"\\items.items.[INDEX].issueDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Issue date","example":"2022-09-15","uniqueKey":"\\items.items.[INDEX].issueDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].issueDate","typeLabel":"string | null"},"billingPeriodStart":{"oneOf":[{"type":"string","description":"Billing period start","example":"2022-10-01T00:00:00Z","uniqueKey":"\\items.items.[INDEX].billingPeriodStart.oneOf.0","typeLabel":"string"},{"type":"null","description":"Billing period start","example":"2022-10-01T00:00:00Z","uniqueKey":"\\items.items.[INDEX].billingPeriodStart.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].billingPeriodStart","typeLabel":"string | null"},"billingPeriodEnd":{"oneOf":[{"type":"string","description":"Billing period end","example":"2022-10-30T00:00:00Z","uniqueKey":"\\items.items.[INDEX].billingPeriodEnd.oneOf.0","typeLabel":"string"},{"type":"null","description":"Billing period end","example":"2022-10-30T00:00:00Z","uniqueKey":"\\items.items.[INDEX].billingPeriodEnd.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].billingPeriodEnd","typeLabel":"string | null"},"creditNoteNumber":{"oneOf":[{"type":"string","description":"Credit Note number","example":"CN00001","uniqueKey":"\\items.items.[INDEX].creditNoteNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Credit Note number","example":"CN00001","uniqueKey":"\\items.items.[INDEX].creditNoteNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].creditNoteNumber","typeLabel":"string | null"},"purchaseOrderNumber":{"oneOf":[{"type":"string","description":"Purchase order number","example":"PO123","uniqueKey":"\\items.items.[INDEX].purchaseOrderNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Purchase order number","example":"PO123","uniqueKey":"\\items.items.[INDEX].purchaseOrderNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].purchaseOrderNumber","typeLabel":"string | null"},"memo":{"oneOf":[{"type":"string","description":"Credit Note memo","example":"Thanks","uniqueKey":"\\items.items.[INDEX].memo.oneOf.0","typeLabel":"string"},{"type":"null","description":"Credit Note memo","example":"Thanks","uniqueKey":"\\items.items.[INDEX].memo.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].memo","typeLabel":"string | null"},"customerTaxId":{"oneOf":[{"type":"string","description":"Customer's tax ID","example":"TAX123","uniqueKey":"\\items.items.[INDEX].customerTaxId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer's tax ID","example":"TAX123","uniqueKey":"\\items.items.[INDEX].customerTaxId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].customerTaxId","typeLabel":"string | null"},"applicationStatus":{"oneOf":[{"type":"string","example":"PARTIALLY_APPLIED","enum":["UNAPPLIED","PARTIALLY_APPLIED","FULLY_APPLIED","UNKNOWN"],"description":"Application status derived from the ledger account balance. Omitted for credit notes that are not in a terminal status","uniqueKey":"\\items.items.[INDEX].applicationStatus.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"PARTIALLY_APPLIED","enum":["UNAPPLIED","PARTIALLY_APPLIED","FULLY_APPLIED","UNKNOWN"],"description":"Application status derived from the ledger account balance. Omitted for credit notes that are not in a terminal status","uniqueKey":"\\items.items.[INDEX].applicationStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].applicationStatus","typeLabel":"enum\u003cstring> | null"},"balance":{"oneOf":[{"type":"string","description":"Credit still available to apply, in decimal format of the Credit Note's currency. Omitted for credit notes with no ledger balance","example":"51.23","uniqueKey":"\\items.items.[INDEX].balance.oneOf.0","typeLabel":"string"},{"type":"null","description":"Credit still available to apply, in decimal format of the Credit Note's currency. Omitted for credit notes with no ledger balance","example":"51.23","uniqueKey":"\\items.items.[INDEX].balance.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].balance","typeLabel":"string | null"},"balanceVersion":{"oneOf":[{"type":"integer","description":"Ledger version of the balance. Advances each time the balance changes; required when applying this Credit Note to an Invoice. Omitted for credit notes with no ledger balance","format":"int64","example":3,"uniqueKey":"\\items.items.[INDEX].balanceVersion.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Ledger version of the balance. Advances each time the balance changes; required when applying this Credit Note to an Invoice. Omitted for credit notes with no ledger balance","format":"int64","example":3,"uniqueKey":"\\items.items.[INDEX].balanceVersion.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].balanceVersion","typeLabel":"integer\u003cint64> | null"},"merchantDetails":{"oneOf":[{"required":["address","customFields","email","includeBeneficiaryAddressInPaymentDetails","legalCompanyName"],"type":"object","description":"Merchant details","example":{"address":{"line1":"The White House","line2":"1600 Pennsylvania Avenue","town":"Washington, D.C.","state":"CA","postcode":"20500","country":"US"},"phoneNumber":"0800001066","email":"donald@example.com","taxId":"TAX60","iban":"GB33BUKB20201555555555","ukAccountDetails":{"sortCode":"000000","accountNumber":"12345678"},"usAchDetails":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789"},"usWireDetails":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789","swiftCode":"CHASUS33","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"}},"caBankAccountDetails":{"transitNumber":"123","institutionNumber":"12345","accountNumber":"1234567"},"canadianInternationalDestination":{"legalName":"John Doe","accountNumber":"12345678","transitNumber":"12345","bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"institutionNumber":"123","swiftCode":"CHASUS33","intermediaryBank":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"}},"australianDestination":{"legalName":"John Doe","accountNumber":"12345678","swiftCode":"CHASUS33","bsb":"123456"},"swedishBankgiroDestination":{"bankgiroNumber":"123-4567","accountName":"12345678"},"logoUrl":"logo","legalCompanyName":"The Merchant","primaryColour":"#000000","customFields":[{"key":"example-label","value":"label-value"}],"includeBeneficiaryAddressInPaymentDetails":true},"properties":{"address":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.address.line1","typeLabel":"string"},"town":{"type":"string","description":"Town or city","example":"Yemen","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.address.town","typeLabel":"string"},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.address.postcode","typeLabel":"string"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.address.country","typeLabel":"enum\u003cstring>"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.address.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2","example":"15 Yemen Road","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.address.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.address.line2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.address.state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.address.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.address.state","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.address","typeLabel":"object"},"email":{"type":"string","description":"Merchant's email","example":"donald@example.com","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.email","typeLabel":"string"},"legalCompanyName":{"type":"string","description":"Merchant's legal company name","example":"The Merchant","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.legalCompanyName","typeLabel":"string"},"customFields":{"type":"array","description":"merchantCustomFields","example":[{"key":"example-label","value":"label-value"}],"items":{"required":["key","value"],"type":"object","example":{"key":"example-label","value":"label-value"},"properties":{"key":{"type":"string","example":"example-label","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.customFields.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","example":"label-value","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.customFields.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.customFields.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.customFields","typeLabel":"object[]"},"includeBeneficiaryAddressInPaymentDetails":{"type":"boolean","description":"Include beneficiary address in payment details on invoice","example":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.includeBeneficiaryAddressInPaymentDetails","typeLabel":"boolean"},"phoneNumber":{"oneOf":[{"type":"string","description":"Merchant's phone number","example":"0800001066","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant's phone number","example":"0800001066","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.phoneNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.phoneNumber","typeLabel":"string | null"},"taxId":{"oneOf":[{"type":"string","description":"Merchant's tax ID","example":"TAX60","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.taxId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant's tax ID","example":"TAX60","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.taxId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.taxId","typeLabel":"string | null"},"iban":{"oneOf":[{"type":"string","description":"Merchant's IBAN, for receiving payment by bank transfer","example":"GB33BUKB20201555555555","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.iban.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant's IBAN, for receiving payment by bank transfer","example":"GB33BUKB20201555555555","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.iban.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.iban","typeLabel":"string | null"},"ukAccountDetails":{"oneOf":[{"required":["accountNumber","sortCode"],"type":"object","description":"Merchant's UK bank account details, for receiving payment by UK bank transfer","example":{"sortCode":"000000","accountNumber":"12345678"},"properties":{"sortCode":{"type":"string","description":"UK sort code. 6 digits.","example":"000000","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.ukAccountDetails.oneOf.0.sortCode","typeLabel":"string"},"accountNumber":{"type":"string","description":"UK account number. 8 digits.","example":"12345678","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.ukAccountDetails.oneOf.0.accountNumber","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.ukAccountDetails.oneOf.0","typeLabel":"object"},{"required":["accountNumber","sortCode"],"type":"null","description":"Merchant's UK bank account details, for receiving payment by UK bank transfer","example":{"sortCode":"000000","accountNumber":"12345678"},"properties":{"sortCode":{"type":"string","description":"UK sort code. 6 digits.","example":"000000"},"accountNumber":{"type":"string","description":"UK account number. 8 digits.","example":"12345678"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.ukAccountDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.ukAccountDetails","typeLabel":"object | null"},"usAchDetails":{"oneOf":[{"required":["accountName","accountNumber","bankName","bankRoutingNumber"],"type":"object","description":"Merchant's US account details, for receiving payment by ACH","example":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789"},"properties":{"accountNumber":{"type":"string","example":"12345678","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usAchDetails.oneOf.0.accountNumber","typeLabel":"string"},"accountName":{"type":"string","example":"John Doe","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usAchDetails.oneOf.0.accountName","typeLabel":"string"},"bankName":{"type":"string","example":"Chase","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usAchDetails.oneOf.0.bankName","typeLabel":"string"},"bankRoutingNumber":{"type":"string","example":"123456789","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usAchDetails.oneOf.0.bankRoutingNumber","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usAchDetails.oneOf.0","typeLabel":"object"},{"required":["accountName","accountNumber","bankName","bankRoutingNumber"],"type":"null","description":"Merchant's US account details, for receiving payment by ACH","example":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789"},"properties":{"accountNumber":{"type":"string","example":"12345678"},"accountName":{"type":"string","example":"John Doe"},"bankName":{"type":"string","example":"Chase"},"bankRoutingNumber":{"type":"string","example":"123456789"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usAchDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usAchDetails","typeLabel":"object | null"},"usWireDetails":{"oneOf":[{"required":["accountName","accountNumber","bankAddress","bankName","bankRoutingNumber","swiftCode"],"type":"object","description":"Merchant's US account details, for receiving payment by wire transfer","example":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789","swiftCode":"CHASUS33","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"}},"properties":{"accountNumber":{"type":"string","example":"12345678","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.accountNumber","typeLabel":"string"},"accountName":{"type":"string","example":"John Doe","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.accountName","typeLabel":"string"},"bankName":{"type":"string","example":"Chase","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankName","typeLabel":"string"},"bankRoutingNumber":{"type":"string","example":"123456789","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankRoutingNumber","typeLabel":"string"},"swiftCode":{"type":"string","example":"CHASUS33","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.swiftCode","typeLabel":"string"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankAddress.line1","typeLabel":"string"},"town":{"type":"string","description":"Town or city","example":"Yemen","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankAddress.town","typeLabel":"string"},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankAddress.postcode","typeLabel":"string"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankAddress.country","typeLabel":"enum\u003cstring>"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankAddress.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2","example":"15 Yemen Road","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankAddress.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankAddress.line2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankAddress.state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankAddress.state","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0.bankAddress","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.0","typeLabel":"object"},{"required":["accountName","accountNumber","bankAddress","bankName","bankRoutingNumber","swiftCode"],"type":"null","description":"Merchant's US account details, for receiving payment by wire transfer","example":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789","swiftCode":"CHASUS33","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"}},"properties":{"accountNumber":{"type":"string","example":"12345678"},"accountName":{"type":"string","example":"John Doe"},"bankName":{"type":"string","example":"Chase"},"bankRoutingNumber":{"type":"string","example":"123456789"},"swiftCode":{"type":"string","example":"CHASUS33"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.usWireDetails","typeLabel":"object | null"},"caBankAccountDetails":{"oneOf":[{"required":["accountNumber","institutionNumber","transitNumber"],"type":"object","description":"Merchant's Canadian account details, for receiving payment by Canadian bank transfer","example":{"transitNumber":"123","institutionNumber":"12345","accountNumber":"1234567"},"properties":{"transitNumber":{"type":"string","example":"123","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.caBankAccountDetails.oneOf.0.transitNumber","typeLabel":"string"},"institutionNumber":{"type":"string","example":"12345","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.caBankAccountDetails.oneOf.0.institutionNumber","typeLabel":"string"},"accountNumber":{"type":"string","example":"1234567","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.caBankAccountDetails.oneOf.0.accountNumber","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.caBankAccountDetails.oneOf.0","typeLabel":"object"},{"required":["accountNumber","institutionNumber","transitNumber"],"type":"null","description":"Merchant's Canadian account details, for receiving payment by Canadian bank transfer","example":{"transitNumber":"123","institutionNumber":"12345","accountNumber":"1234567"},"properties":{"transitNumber":{"type":"string","example":"123"},"institutionNumber":{"type":"string","example":"12345"},"accountNumber":{"type":"string","example":"1234567"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.caBankAccountDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.caBankAccountDetails","typeLabel":"object | null"},"canadianInternationalDestination":{"oneOf":[{"required":["accountNumber","bankAddress","bankName","institutionNumber","legalName","swiftCode","transitNumber"],"type":"object","description":"Merchant's account details, for receiving payment to a Canadian bank via Wire transfer","example":{"legalName":"John Doe","accountNumber":"12345678","transitNumber":"12345","bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"institutionNumber":"123","swiftCode":"CHASUS33","intermediaryBank":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"}},"properties":{"legalName":{"type":"string","example":"John Doe","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.legalName","typeLabel":"string"},"accountNumber":{"type":"string","example":"12345678","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.accountNumber","typeLabel":"string"},"transitNumber":{"type":"string","example":"12345","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.transitNumber","typeLabel":"string"},"bankName":{"type":"string","example":"Chase","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.bankName","typeLabel":"string"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.bankAddress.line1","typeLabel":"string"},"town":{"type":"string","description":"Town or city","example":"Yemen","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.bankAddress.town","typeLabel":"string"},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.bankAddress.postcode","typeLabel":"string"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.bankAddress.country","typeLabel":"enum\u003cstring>"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.bankAddress.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2","example":"15 Yemen Road","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.bankAddress.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.bankAddress.line2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.bankAddress.state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.bankAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.bankAddress.state","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.bankAddress","typeLabel":"object"},"institutionNumber":{"type":"string","example":"123","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.institutionNumber","typeLabel":"string"},"swiftCode":{"type":"string","example":"CHASUS33","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.swiftCode","typeLabel":"string"},"intermediaryBank":{"oneOf":[{"required":["bankAddress","bankName","routingNumber","swiftCode"],"type":"object","example":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"},"properties":{"bankName":{"type":"string","example":"Chase","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.bankName","typeLabel":"string"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.bankAddress.line1","typeLabel":"string"},"town":{"type":"string","description":"Town or city","example":"Yemen","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.bankAddress.town","typeLabel":"string"},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.bankAddress.postcode","typeLabel":"string"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.bankAddress.country","typeLabel":"enum\u003cstring>"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.bankAddress.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2","example":"15 Yemen Road","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.bankAddress.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.bankAddress.line2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.bankAddress.state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.bankAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.bankAddress.state","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.bankAddress","typeLabel":"object"},"swiftCode":{"type":"string","example":"CHASUS33","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.swiftCode","typeLabel":"string"},"routingNumber":{"type":"string","example":"123456789","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0.routingNumber","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.0","typeLabel":"object"},{"required":["bankAddress","bankName","routingNumber","swiftCode"],"type":"null","example":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"},"properties":{"bankName":{"type":"string","example":"Chase"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}},"swiftCode":{"type":"string","example":"CHASUS33"},"routingNumber":{"type":"string","example":"123456789"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0.intermediaryBank","typeLabel":"object | null"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.0","typeLabel":"object"},{"required":["accountNumber","bankAddress","bankName","institutionNumber","legalName","swiftCode","transitNumber"],"type":"null","description":"Merchant's account details, for receiving payment to a Canadian bank via Wire transfer","example":{"legalName":"John Doe","accountNumber":"12345678","transitNumber":"12345","bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"institutionNumber":"123","swiftCode":"CHASUS33","intermediaryBank":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"}},"properties":{"legalName":{"type":"string","example":"John Doe"},"accountNumber":{"type":"string","example":"12345678"},"transitNumber":{"type":"string","example":"12345"},"bankName":{"type":"string","example":"Chase"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}},"institutionNumber":{"type":"string","example":"123"},"swiftCode":{"type":"string","example":"CHASUS33"},"intermediaryBank":{"oneOf":[{"required":["bankAddress","bankName","routingNumber","swiftCode"],"type":"object","example":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"},"properties":{"bankName":{"type":"string","example":"Chase"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}},"swiftCode":{"type":"string","example":"CHASUS33"},"routingNumber":{"type":"string","example":"123456789"}}},{"required":["bankAddress","bankName","routingNumber","swiftCode"],"type":"null","example":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"},"properties":{"bankName":{"type":"string","example":"Chase"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}},"swiftCode":{"type":"string","example":"CHASUS33"},"routingNumber":{"type":"string","example":"123456789"}}}]}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.canadianInternationalDestination","typeLabel":"object | null"},"australianDestination":{"oneOf":[{"required":["accountNumber","bsb","legalName","swiftCode"],"type":"object","description":"Merchant's account details, for receiving payment to a Canadian bank via Australian bank transfer","example":{"legalName":"John Doe","accountNumber":"12345678","swiftCode":"CHASUS33","bsb":"123456"},"properties":{"legalName":{"type":"string","example":"John Doe","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.australianDestination.oneOf.0.legalName","typeLabel":"string"},"accountNumber":{"type":"string","example":"12345678","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.australianDestination.oneOf.0.accountNumber","typeLabel":"string"},"swiftCode":{"type":"string","example":"CHASUS33","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.australianDestination.oneOf.0.swiftCode","typeLabel":"string"},"bsb":{"type":"string","example":"123456","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.australianDestination.oneOf.0.bsb","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.australianDestination.oneOf.0","typeLabel":"object"},{"required":["accountNumber","bsb","legalName","swiftCode"],"type":"null","description":"Merchant's account details, for receiving payment to a Canadian bank via Australian bank transfer","example":{"legalName":"John Doe","accountNumber":"12345678","swiftCode":"CHASUS33","bsb":"123456"},"properties":{"legalName":{"type":"string","example":"John Doe"},"accountNumber":{"type":"string","example":"12345678"},"swiftCode":{"type":"string","example":"CHASUS33"},"bsb":{"type":"string","example":"123456"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.australianDestination.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.australianDestination","typeLabel":"object | null"},"swedishBankgiroDestination":{"oneOf":[{"required":["accountName","bankgiroNumber"],"type":"object","description":"Merchant's Swedish Bankgiro account details, for receiving payment by Swedish Bankgiro","example":{"bankgiroNumber":"123-4567","accountName":"12345678"},"properties":{"bankgiroNumber":{"type":"string","description":"Swedish Bankgiro number. 7-8 digits, formatted as 123-4567 or 1234-5678.","example":"123-4567","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.swedishBankgiroDestination.oneOf.0.bankgiroNumber","typeLabel":"string"},"accountName":{"type":"string","description":"Account holder name","example":"12345678","isRequired":true,"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.swedishBankgiroDestination.oneOf.0.accountName","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.swedishBankgiroDestination.oneOf.0","typeLabel":"object"},{"required":["accountName","bankgiroNumber"],"type":"null","description":"Merchant's Swedish Bankgiro account details, for receiving payment by Swedish Bankgiro","example":{"bankgiroNumber":"123-4567","accountName":"12345678"},"properties":{"bankgiroNumber":{"type":"string","description":"Swedish Bankgiro number. 7-8 digits, formatted as 123-4567 or 1234-5678.","example":"123-4567"},"accountName":{"type":"string","description":"Account holder name","example":"12345678"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.swedishBankgiroDestination.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.swedishBankgiroDestination","typeLabel":"object | null"},"logoUrl":{"oneOf":[{"type":"string","description":"Merchant's logo image URL","example":"logo","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.logoUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant's logo image URL","example":"logo","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.logoUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.logoUrl","typeLabel":"string | null"},"primaryColour":{"oneOf":[{"type":"string","description":"Merchant's primary colour (for invoice rendering)","example":"#000000","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.primaryColour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant's primary colour (for invoice rendering)","example":"#000000","uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.primaryColour.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0.primaryColour","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.0","typeLabel":"object"},{"required":["address","customFields","email","includeBeneficiaryAddressInPaymentDetails","legalCompanyName"],"type":"null","description":"Merchant details","example":{"address":{"line1":"The White House","line2":"1600 Pennsylvania Avenue","town":"Washington, D.C.","state":"CA","postcode":"20500","country":"US"},"phoneNumber":"0800001066","email":"donald@example.com","taxId":"TAX60","iban":"GB33BUKB20201555555555","ukAccountDetails":{"sortCode":"000000","accountNumber":"12345678"},"usAchDetails":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789"},"usWireDetails":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789","swiftCode":"CHASUS33","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"}},"caBankAccountDetails":{"transitNumber":"123","institutionNumber":"12345","accountNumber":"1234567"},"canadianInternationalDestination":{"legalName":"John Doe","accountNumber":"12345678","transitNumber":"12345","bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"institutionNumber":"123","swiftCode":"CHASUS33","intermediaryBank":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"}},"australianDestination":{"legalName":"John Doe","accountNumber":"12345678","swiftCode":"CHASUS33","bsb":"123456"},"swedishBankgiroDestination":{"bankgiroNumber":"123-4567","accountName":"12345678"},"logoUrl":"logo","legalCompanyName":"The Merchant","primaryColour":"#000000","customFields":[{"key":"example-label","value":"label-value"}],"includeBeneficiaryAddressInPaymentDetails":true},"properties":{"address":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}},"phoneNumber":{"oneOf":[{"type":"string","description":"Merchant's phone number","example":"0800001066"},{"type":"null","description":"Merchant's phone number","example":"0800001066"}]},"email":{"type":"string","description":"Merchant's email","example":"donald@example.com"},"taxId":{"oneOf":[{"type":"string","description":"Merchant's tax ID","example":"TAX60"},{"type":"null","description":"Merchant's tax ID","example":"TAX60"}]},"iban":{"oneOf":[{"type":"string","description":"Merchant's IBAN, for receiving payment by bank transfer","example":"GB33BUKB20201555555555"},{"type":"null","description":"Merchant's IBAN, for receiving payment by bank transfer","example":"GB33BUKB20201555555555"}]},"ukAccountDetails":{"oneOf":[{"required":["accountNumber","sortCode"],"type":"object","description":"Merchant's UK bank account details, for receiving payment by UK bank transfer","example":{"sortCode":"000000","accountNumber":"12345678"},"properties":{"sortCode":{"type":"string","description":"UK sort code. 6 digits.","example":"000000"},"accountNumber":{"type":"string","description":"UK account number. 8 digits.","example":"12345678"}}},{"required":["accountNumber","sortCode"],"type":"null","description":"Merchant's UK bank account details, for receiving payment by UK bank transfer","example":{"sortCode":"000000","accountNumber":"12345678"},"properties":{"sortCode":{"type":"string","description":"UK sort code. 6 digits.","example":"000000"},"accountNumber":{"type":"string","description":"UK account number. 8 digits.","example":"12345678"}}}]},"usAchDetails":{"oneOf":[{"required":["accountName","accountNumber","bankName","bankRoutingNumber"],"type":"object","description":"Merchant's US account details, for receiving payment by ACH","example":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789"},"properties":{"accountNumber":{"type":"string","example":"12345678"},"accountName":{"type":"string","example":"John Doe"},"bankName":{"type":"string","example":"Chase"},"bankRoutingNumber":{"type":"string","example":"123456789"}}},{"required":["accountName","accountNumber","bankName","bankRoutingNumber"],"type":"null","description":"Merchant's US account details, for receiving payment by ACH","example":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789"},"properties":{"accountNumber":{"type":"string","example":"12345678"},"accountName":{"type":"string","example":"John Doe"},"bankName":{"type":"string","example":"Chase"},"bankRoutingNumber":{"type":"string","example":"123456789"}}}]},"usWireDetails":{"oneOf":[{"required":["accountName","accountNumber","bankAddress","bankName","bankRoutingNumber","swiftCode"],"type":"object","description":"Merchant's US account details, for receiving payment by wire transfer","example":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789","swiftCode":"CHASUS33","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"}},"properties":{"accountNumber":{"type":"string","example":"12345678"},"accountName":{"type":"string","example":"John Doe"},"bankName":{"type":"string","example":"Chase"},"bankRoutingNumber":{"type":"string","example":"123456789"},"swiftCode":{"type":"string","example":"CHASUS33"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}}}},{"required":["accountName","accountNumber","bankAddress","bankName","bankRoutingNumber","swiftCode"],"type":"null","description":"Merchant's US account details, for receiving payment by wire transfer","example":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789","swiftCode":"CHASUS33","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"}},"properties":{"accountNumber":{"type":"string","example":"12345678"},"accountName":{"type":"string","example":"John Doe"},"bankName":{"type":"string","example":"Chase"},"bankRoutingNumber":{"type":"string","example":"123456789"},"swiftCode":{"type":"string","example":"CHASUS33"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}}}}]},"caBankAccountDetails":{"oneOf":[{"required":["accountNumber","institutionNumber","transitNumber"],"type":"object","description":"Merchant's Canadian account details, for receiving payment by Canadian bank transfer","example":{"transitNumber":"123","institutionNumber":"12345","accountNumber":"1234567"},"properties":{"transitNumber":{"type":"string","example":"123"},"institutionNumber":{"type":"string","example":"12345"},"accountNumber":{"type":"string","example":"1234567"}}},{"required":["accountNumber","institutionNumber","transitNumber"],"type":"null","description":"Merchant's Canadian account details, for receiving payment by Canadian bank transfer","example":{"transitNumber":"123","institutionNumber":"12345","accountNumber":"1234567"},"properties":{"transitNumber":{"type":"string","example":"123"},"institutionNumber":{"type":"string","example":"12345"},"accountNumber":{"type":"string","example":"1234567"}}}]},"canadianInternationalDestination":{"oneOf":[{"required":["accountNumber","bankAddress","bankName","institutionNumber","legalName","swiftCode","transitNumber"],"type":"object","description":"Merchant's account details, for receiving payment to a Canadian bank via Wire transfer","example":{"legalName":"John Doe","accountNumber":"12345678","transitNumber":"12345","bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"institutionNumber":"123","swiftCode":"CHASUS33","intermediaryBank":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"}},"properties":{"legalName":{"type":"string","example":"John Doe"},"accountNumber":{"type":"string","example":"12345678"},"transitNumber":{"type":"string","example":"12345"},"bankName":{"type":"string","example":"Chase"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}},"institutionNumber":{"type":"string","example":"123"},"swiftCode":{"type":"string","example":"CHASUS33"},"intermediaryBank":{"oneOf":[{"required":["bankAddress","bankName","routingNumber","swiftCode"],"type":"object","example":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"},"properties":{"bankName":{"type":"string","example":"Chase"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}},"swiftCode":{"type":"string","example":"CHASUS33"},"routingNumber":{"type":"string","example":"123456789"}}},{"required":["bankAddress","bankName","routingNumber","swiftCode"],"type":"null","example":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"},"properties":{"bankName":{"type":"string","example":"Chase"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}},"swiftCode":{"type":"string","example":"CHASUS33"},"routingNumber":{"type":"string","example":"123456789"}}}]}}},{"required":["accountNumber","bankAddress","bankName","institutionNumber","legalName","swiftCode","transitNumber"],"type":"null","description":"Merchant's account details, for receiving payment to a Canadian bank via Wire transfer","example":{"legalName":"John Doe","accountNumber":"12345678","transitNumber":"12345","bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"institutionNumber":"123","swiftCode":"CHASUS33","intermediaryBank":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"}},"properties":{"legalName":{"type":"string","example":"John Doe"},"accountNumber":{"type":"string","example":"12345678"},"transitNumber":{"type":"string","example":"12345"},"bankName":{"type":"string","example":"Chase"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}},"institutionNumber":{"type":"string","example":"123"},"swiftCode":{"type":"string","example":"CHASUS33"},"intermediaryBank":{"oneOf":[{"required":["bankAddress","bankName","routingNumber","swiftCode"],"type":"object","example":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"},"properties":{"bankName":{"type":"string","example":"Chase"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}},"swiftCode":{"type":"string","example":"CHASUS33"},"routingNumber":{"type":"string","example":"123456789"}}},{"required":["bankAddress","bankName","routingNumber","swiftCode"],"type":"null","example":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"},"properties":{"bankName":{"type":"string","example":"Chase"},"bankAddress":{"required":["country","line1","postcode","town"],"type":"object","description":"Customer's billing address","example":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"Flat 1"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"15 Yemen Road"},{"type":"null","description":"Address line 2","example":"15 Yemen Road"}]},"town":{"type":"string","description":"Town or city","example":"Yemen"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"YE1 2YE"},"country":{"type":"string","example":"YE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","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","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","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","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":"Country. Request values can be an ISO 3166-1 alpha-2 code such as `GB` ([list](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)), an alpha-3 code such as `GBR`, a country name or a common alias (\"United Kingdom\", \"UK\"), in any case. Response values always use the alpha-2 code."}}},"swiftCode":{"type":"string","example":"CHASUS33"},"routingNumber":{"type":"string","example":"123456789"}}}]}}}]},"australianDestination":{"oneOf":[{"required":["accountNumber","bsb","legalName","swiftCode"],"type":"object","description":"Merchant's account details, for receiving payment to a Canadian bank via Australian bank transfer","example":{"legalName":"John Doe","accountNumber":"12345678","swiftCode":"CHASUS33","bsb":"123456"},"properties":{"legalName":{"type":"string","example":"John Doe"},"accountNumber":{"type":"string","example":"12345678"},"swiftCode":{"type":"string","example":"CHASUS33"},"bsb":{"type":"string","example":"123456"}}},{"required":["accountNumber","bsb","legalName","swiftCode"],"type":"null","description":"Merchant's account details, for receiving payment to a Canadian bank via Australian bank transfer","example":{"legalName":"John Doe","accountNumber":"12345678","swiftCode":"CHASUS33","bsb":"123456"},"properties":{"legalName":{"type":"string","example":"John Doe"},"accountNumber":{"type":"string","example":"12345678"},"swiftCode":{"type":"string","example":"CHASUS33"},"bsb":{"type":"string","example":"123456"}}}]},"swedishBankgiroDestination":{"oneOf":[{"required":["accountName","bankgiroNumber"],"type":"object","description":"Merchant's Swedish Bankgiro account details, for receiving payment by Swedish Bankgiro","example":{"bankgiroNumber":"123-4567","accountName":"12345678"},"properties":{"bankgiroNumber":{"type":"string","description":"Swedish Bankgiro number. 7-8 digits, formatted as 123-4567 or 1234-5678.","example":"123-4567"},"accountName":{"type":"string","description":"Account holder name","example":"12345678"}}},{"required":["accountName","bankgiroNumber"],"type":"null","description":"Merchant's Swedish Bankgiro account details, for receiving payment by Swedish Bankgiro","example":{"bankgiroNumber":"123-4567","accountName":"12345678"},"properties":{"bankgiroNumber":{"type":"string","description":"Swedish Bankgiro number. 7-8 digits, formatted as 123-4567 or 1234-5678.","example":"123-4567"},"accountName":{"type":"string","description":"Account holder name","example":"12345678"}}}]},"logoUrl":{"oneOf":[{"type":"string","description":"Merchant's logo image URL","example":"logo"},{"type":"null","description":"Merchant's logo image URL","example":"logo"}]},"legalCompanyName":{"type":"string","description":"Merchant's legal company name","example":"The Merchant"},"primaryColour":{"oneOf":[{"type":"string","description":"Merchant's primary colour (for invoice rendering)","example":"#000000"},{"type":"null","description":"Merchant's primary colour (for invoice rendering)","example":"#000000"}]},"customFields":{"type":"array","description":"merchantCustomFields","example":[{"key":"example-label","value":"label-value"}],"items":{"required":["key","value"],"type":"object","example":{"key":"example-label","value":"label-value"},"properties":{"key":{"type":"string","example":"example-label"},"value":{"type":"string","example":"label-value"}}}},"includeBeneficiaryAddressInPaymentDetails":{"type":"boolean","description":"Include beneficiary address in payment details on invoice","example":true}},"uniqueKey":"\\items.items.[INDEX].merchantDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].merchantDetails","typeLabel":"object | null"},"accountingDate":{"oneOf":[{"type":"string","description":"Accounting date","example":"2022-09-30","uniqueKey":"\\items.items.[INDEX].accountingDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Accounting date","example":"2022-09-30","uniqueKey":"\\items.items.[INDEX].accountingDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].accountingDate","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"},"pagination":{"type":"object","description":"Results pagination","example":{"after":"ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==","before":"NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND","totalResultSize":100},"properties":{"after":{"oneOf":[{"type":"string","description":"Copy this value to the `after` parameter of your next request to retrieve the next page of results","example":"ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==","uniqueKey":"pagination.after.oneOf.0","typeLabel":"string"},{"type":"null","description":"Copy this value to the `after` parameter of your next request to retrieve the next page of results","example":"ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==","uniqueKey":"pagination.after.oneOf.1","typeLabel":"null"}],"uniqueKey":"pagination.after","typeLabel":"string | null"},"before":{"oneOf":[{"type":"string","description":"Copy this value to the `before` parameter of your next request to retrieve the next page of results","example":"NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND","uniqueKey":"pagination.before.oneOf.0","typeLabel":"string"},{"type":"null","description":"Copy this value to the `before` parameter of your next request to retrieve the next page of results","example":"NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND","uniqueKey":"pagination.before.oneOf.1","typeLabel":"null"}],"uniqueKey":"pagination.before","typeLabel":"string | null"},"totalResultSize":{"oneOf":[{"type":"integer","description":"Total number of entries across all pages","format":"int64","example":100,"uniqueKey":"pagination.totalResultSize.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Total number of entries across all pages","format":"int64","example":100,"uniqueKey":"pagination.totalResultSize.oneOf.1","typeLabel":"null"}],"uniqueKey":"pagination.totalResultSize","typeLabel":"integer\u003cint64> | null"}},"isRequired":true,"uniqueKey":"pagination","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"ListCreditNoteEndpointProductListCreditNotePaginatedResponseModel":{"title":"ListCreditNoteEndpointProductListCreditNotePaginatedResponseModel","value":{"items":[{"id":"af60cab3-812d-4250-a051-0fb7133a00c7","sequenceAccountId":"68233908-402a-43b4-8952-1c2ab0ef0b25","status":"SENT","invoiceId":"af60cab3-812d-4250-a051-0fb7133a00c7","invoiceNumber":"INV00001","billingScheduleId":"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95","currency":"GBP","issueDate":"2022-09-15","billingPeriodStart":"2022-10-01T00:00:00Z","billingPeriodEnd":"2022-10-30T00:00:00Z","creditNoteNumber":"CN00001","purchaseOrderNumber":"PO123","customerId":"61b083e0-1faa-47ca-9aeb-6205da8f6c47","customerEmails":["customer@example.com","customer.alias@example.com"],"customerLegalCompanyName":"Facebook","customerBillingAddress":{"line1":"Flat 1","line2":"15 Yemen Road","town":"Yemen","state":"CA","postcode":"YE1 2YE","country":"YE"},"customerShippingAddress":{"line1":"742 Evergreen Terrace","town":"Springfield","state":"CA","postcode":"12345","country":"US"},"memo":"Thanks","totalTax":"2.50","netTotal":"51.20","grossTotal":"101.23","metadata":[{"key":"example-label","value":"label-value"}],"customerTaxId":"TAX123","linkedServices":[{"externalId":"123","externalService":"Xero","syncTime":"2022-06-28T16:47:00Z","externalUrl":"https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"}],"applicationStatus":"PARTIALLY_APPLIED","balance":"51.23","balanceVersion":3,"applications":[{"invoiceId":"af60cab3-812d-4250-a051-0fb7133a00c7","invoiceNumber":"INV00001","amount":"50.00","appliedAt":"2022-10-14T12:34:56Z"}],"merchantDetails":{"address":{"line1":"The White House","line2":"1600 Pennsylvania Avenue","town":"Washington, D.C.","state":"CA","postcode":"20500","country":"US"},"phoneNumber":"0800001066","email":"donald@example.com","taxId":"TAX60","iban":"GB33BUKB20201555555555","ukAccountDetails":{"sortCode":"000000","accountNumber":"12345678"},"usAchDetails":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789"},"usWireDetails":{"accountNumber":"12345678","accountName":"John Doe","bankName":"Chase","bankRoutingNumber":"123456789","swiftCode":"CHASUS33","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"}},"caBankAccountDetails":{"transitNumber":"123","institutionNumber":"12345","accountNumber":"1234567"},"canadianInternationalDestination":{"legalName":"John Doe","accountNumber":"12345678","transitNumber":"12345","bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"institutionNumber":"123","swiftCode":"CHASUS33","intermediaryBank":{"bankName":"Chase","bankAddress":{"line1":"JP Morgan Chase","town":"New York City","state":"NY","postcode":"10017","country":"US"},"swiftCode":"CHASUS33","routingNumber":"123456789"}},"australianDestination":{"legalName":"John Doe","accountNumber":"12345678","swiftCode":"CHASUS33","bsb":"123456"},"swedishBankgiroDestination":{"bankgiroNumber":"123-4567","accountName":"12345678"},"logoUrl":"logo","legalCompanyName":"The Merchant","primaryColour":"#000000","customFields":[{"key":"example-label","value":"label-value"}],"includeBeneficiaryAddressInPaymentDetails":true},"settings":{"generateCashCreditGrant":"ENABLED"},"accountingDate":"2022-09-30"}],"pagination":{"after":"ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==","before":"NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND","totalResultSize":100}}}},"exampleType":"examples"}},"exampleType":"examples"},"d4657ecf-ff0d-47da-ab8a-19cd52c62867":{"description":"Bad Request","content":{},"exampleType":"generated"},"91d61e0c-0a16-4caf-8457-794f5d8b6539":{"description":"Unauthorized","content":{},"exampleType":"generated"},"1739b3e4-0f34-462c-b004-905d1f8de509":{"description":"Internal Server Error","content":{},"exampleType":"generated"}},"security":{},"servers":{}},"originalFileLocation":"open-api-schema/2024-07-30/invoices.2024-07-30.product.live.json"},"subdomain":"sequence","siteName":"Sequence","title":"List all Credit Notes - Sequence","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T13:54:24.283Z","originalFileLocation":"reference/2024-07-30/invoices/list-all-credit-notes.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=\"system\"}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=\"List all Credit Notes for this Sequence account\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sequence\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List all Credit Notes - Sequence\">\u003cmeta data-mint-head property=\"og:description\" content=\"List all Credit Notes for this Sequence account\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sequence\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sequencehq.com/reference/2024-07-30/invoices/list-all-credit-notes\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sequence.mintlify.app/_mintlify/api/og/v2?division=Credit+Notes\u0026amp;title=List+all+Credit+Notes\u0026amp;description=List+all+Credit+Notes+for+this+Sequence+account\u0026amp;theme=9a5e862c56c084d213b04486\u0026amp;signature=fd53a1986209b7b192044a3d0127a83a3a195f907b7dd58b01a3da60b33f4aad\">\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 all Credit Notes - Sequence\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List all Credit Notes for this Sequence account\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sequence.mintlify.app/_mintlify/api/og/v2?division=Credit+Notes\u0026amp;title=List+all+Credit+Notes\u0026amp;description=List+all+Credit+Notes+for+this+Sequence+account\u0026amp;theme=9a5e862c56c084d213b04486\u0026amp;signature=fd53a1986209b7b192044a3d0127a83a3a195f907b7dd58b01a3da60b33f4aad\">\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/sequence/4AxtUIMpbcFOrkSv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sequence\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#716FFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sequencehq.com/reference/2024-07-30/invoices/list-all-credit-notes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/2024-07-30/invoices/list-all-credit-notes.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sequencehq.com/#organization\",\"name\":\"Sequence\",\"url\":\"https://docs.sequencehq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sequence/bptUiZLY1oEfBaTZ/logo/light.svg?fit=max\u0026auto=format\u0026n=bptUiZLY1oEfBaTZ\u0026q=85\u0026s=02adc18f83942b8bdc86ec2b67937e1a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sequencehq.com#website\",\"name\":\"Sequence\",\"url\":\"https://docs.sequencehq.com\",\"publisher\":{\"@id\":\"https://docs.sequencehq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sequencehq.com/reference/2024-07-30/invoices/list-all-credit-notes#webpage\",\"url\":\"https://docs.sequencehq.com/reference/2024-07-30/invoices/list-all-credit-notes\",\"name\":\"List all Credit Notes\",\"description\":\"List all Credit Notes for this Sequence account\",\"dateModified\":\"2026-10-21T13:54:24.283Z\",\"isPartOf\":{\"@id\":\"https://docs.sequencehq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sequencehq.com/reference/2024-07-30/invoices/list-all-credit-notes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sequencehq.com/reference/2024-07-30/invoices/list-all-credit-notes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Version 2024-07-30\",\"item\":\"https://docs.sequencehq.com/reference/2024-07-30/account/list-your-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List all Credit Notes\",\"item\":\"https://docs.sequencehq.com/reference/2024-07-30/invoices/list-all-credit-notes\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sequencehq.com/reference/2024-07-30/invoices/list-all-credit-notes#apireference\",\"headline\":\"List all Credit Notes\",\"name\":\"List all Credit Notes\",\"description\":\"List all Credit Notes for this Sequence account\",\"url\":\"https://docs.sequencehq.com/reference/2024-07-30/invoices/list-all-credit-notes\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sequencehq.com/reference/2024-07-30/invoices/list-all-credit-notes#webpage\"},\"dateModified\":\"2026-10-21T13:54:24.283Z\",\"publisher\":{\"@id\":\"https://docs.sequencehq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sequencehq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sequence\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Sequence","nav":{"global":{"anchors":[{"anchor":"Speak to an expert","icon":"message-check","href":"https://access.sequencehq.com/"},{"anchor":"Changelog","icon":"bolt","href":"https://www.sequencehq.com/changelog"},{"anchor":"Blog","icon":"rss","href":"https://www.sequencehq.com/blog"},{"anchor":"Principles","icon":"bookmark","href":"https://www.sequencehq.com/principles"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/getting-started/overview"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Getting Started","href":"/reference/gettingStarted"},{"title":"Authentication","href":"/reference/authentication"},{"title":"Versioning","href":"/reference/versioning"},{"title":"Changes","href":"/reference/changes"},{"group":"Webhooks","pages":[{"title":"Set up webhooks","href":"/reference/webhooks"},{"title":"Webhook events","href":"/reference/webhook-events"}]}]},{"group":"Latest Live API","pages":[{"group":"Account","pages":[{"group":"Accounts","pages":[{"openapi":"account.latest.product.live GET /sequence-accounts","title":"List your accounts","href":"/reference/latest/account/list-your-accounts"},{"openapi":"account.latest.product.live GET /sequence-accounts/{id}","title":"Get your account","href":"/reference/latest/account/get-your-account"},{"openapi":"account.latest.product.live PUT /sequence-accounts/{id}","title":"Update Account","href":"/reference/latest/account/update-account"}]},{"group":"Users","pages":[{"openapi":"account.latest.product.live GET /users/{id}","title":"Get a user","href":"/reference/latest/account/get-a-user"},{"openapi":"account.latest.product.live DELETE /users/{id}","title":"Delete User","href":"/reference/latest/account/delete-user"},{"openapi":"account.latest.product.live GET /users","title":"List all Users","href":"/reference/latest/account/list-all-users"}]}]},{"group":"Activity Stream","pages":[{"group":"Activities","pages":[{"openapi":"activity-stream.latest.product.live GET /activity-logs/{id}","title":"Get an Activity Log by ID","href":"/reference/latest/activity-stream/get-an-activity-log-by-id"},{"openapi":"activity-stream.latest.product.live GET /activity-logs","title":"List all Activity Logs","href":"/reference/latest/activity-stream/list-all-activity-logs"}]}]},{"group":"Billing","pages":[{"group":"Prices","pages":[{"openapi":"billing.latest.product.live GET /prices","title":"List all Prices","href":"/reference/latest/billing/list-all-prices"},{"openapi":"billing.latest.product.live POST /prices","title":"Create a new Price","href":"/reference/latest/billing/create-a-new-price"},{"openapi":"billing.latest.product.live GET /prices/{id}","title":"Get a Price by ID","href":"/reference/latest/billing/get-a-price-by-id"},{"openapi":"billing.latest.product.live PUT /prices/{id}","title":"Update a Price","href":"/reference/latest/billing/update-a-price"},{"openapi":"billing.latest.product.live DELETE /prices/{id}","title":"Delete a Price","href":"/reference/latest/billing/delete-a-price"},{"openapi":"billing.latest.product.live GET /billing-products","title":"List all billing products","href":"/reference/latest/billing/list-all-billing-products"}]},{"group":"Discounts","pages":[{"openapi":"billing.latest.product.live GET /discounts/{id}","title":"Get a discount by ID","href":"/reference/latest/billing/get-a-discount-by-id"},{"openapi":"billing.latest.product.live PUT /discounts/{id}","title":"Update a discount","href":"/reference/latest/billing/update-a-discount"},{"openapi":"billing.latest.product.live DELETE /discounts/{id}","title":"Delete a discount","href":"/reference/latest/billing/delete-a-discount"},{"openapi":"billing.latest.product.live GET /discounts","title":"List all discounts","href":"/reference/latest/billing/list-all-discounts"}]},{"group":"Billing Schedules","pages":[{"openapi":"billing.latest.product.live POST /billing-schedules/{billingScheduleId}/duplicate","title":"Duplicate a billing schedule","href":"/reference/latest/billing/duplicate-a-billing-schedule"},{"openapi":"billing.latest.product.live GET /billing-schedules","title":"List all Billing Schedules","href":"/reference/latest/billing/list-all-billing-schedules"},{"openapi":"billing.latest.product.live POST /billing-schedules","title":"Create Billing Schedule","href":"/reference/latest/billing/create-billing-schedule"},{"openapi":"billing.latest.product.live POST /billing-schedules/validate-taxes","title":"Validate taxes on a billing schedule","href":"/reference/latest/billing/validate-taxes-on-a-billing-schedule"},{"openapi":"billing.latest.product.live GET /billing-schedules/{billingScheduleId}","title":"Get Billing Schedule","href":"/reference/latest/billing/get-billing-schedule"},{"openapi":"billing.latest.product.live PUT /billing-schedules/{billingScheduleId}","title":"Update Billing Schedule","href":"/reference/latest/billing/update-billing-schedule"},{"openapi":"billing.latest.product.live POST /billing-schedules/{billingScheduleId}/archive","title":"Archive Billing Schedule","href":"/reference/latest/billing/archive-billing-schedule"},{"openapi":"billing.latest.product.live PUT /billing-schedules/{billingScheduleId}/activate","title":"Activate Billing Schedule","href":"/reference/latest/billing/activate-billing-schedule"},{"openapi":"billing.latest.product.live GET /billing-schedule-custom-field-keys","title":"List Billing Schedule Custom Field Keys","href":"/reference/latest/billing/list-billing-schedule-custom-field-keys"}]},{"group":"Credits","pages":[{"openapi":"billing.latest.product.live GET /credit-grants/{id}","title":"Get a credit grant","href":"/reference/latest/billing/get-a-credit-grant"},{"openapi":"billing.latest.product.live GET /credits/{customerId}/grants","title":"List Credit Grants for a customer","href":"/reference/latest/billing/list-credit-grants-for-a-customer"},{"openapi":"billing.latest.product.live GET /credit-grants","title":"List credit grants","href":"/reference/latest/billing/list-credit-grants"},{"openapi":"billing.latest.product.live POST /credit-grants","title":"Create a customer credit grant","href":"/reference/latest/billing/create-a-customer-credit-grant"},{"openapi":"billing.latest.product.live GET /credits","title":"List customer credit grants","href":"/reference/latest/billing/list-customer-credit-grants"},{"openapi":"billing.latest.product.live POST /credits","title":"Create a new credit grant","href":"/reference/latest/billing/create-a-new-credit-grant"},{"openapi":"billing.latest.product.live GET /credits/{id}","title":"Get a customer credit grant","href":"/reference/latest/billing/get-a-customer-credit-grant"},{"openapi":"billing.latest.product.live DELETE /credits/{id}","title":"Delete a credit grant","href":"/reference/latest/billing/delete-a-credit-grant"},{"openapi":"billing.latest.product.live GET /credits/{customerId}/balances","title":"List Credit Balances for a customer","href":"/reference/latest/billing/list-credit-balances-for-a-customer"}]}]},{"group":"Collections","pages":[{"group":"Billing Schedules","pages":[{"openapi":"collections.latest.product.live GET /payments/settings/billing-schedules/{id}","title":"Get billing schedule payment settings","href":"/reference/latest/collections/get-billing-schedule-payment-settings"},{"openapi":"collections.latest.product.live PUT /payments/settings/billing-schedules/{id}","title":"Update billing schedule payment settings","href":"/reference/latest/collections/update-billing-schedule-payment-settings"},{"openapi":"collections.latest.product.live DELETE /payments/settings/billing-schedules/{id}","title":"Delete billing schedule payment settings","href":"/reference/latest/collections/delete-billing-schedule-payment-settings"},{"openapi":"collections.latest.product.live GET /payments/settings/billing-schedules/for-billing-schedule/{id}","title":"Get billing schedule payment settings by billing schedule ID","href":"/reference/latest/collections/get-billing-schedule-payment-settings-by-billing-schedule-id"},{"openapi":"collections.latest.product.live POST /payments/settings/billing-schedules","title":"Create billing schedule payment settings","href":"/reference/latest/collections/create-billing-schedule-payment-settings"}]},{"group":"Customers","pages":[{"openapi":"collections.latest.product.live POST /payments/settings/customers","title":"Create customer payment settings","href":"/reference/latest/collections/create-customer-payment-settings"},{"openapi":"collections.latest.product.live GET /payments/settings/customers/{id}","title":"Get customer payment settings","href":"/reference/latest/collections/get-customer-payment-settings"},{"openapi":"collections.latest.product.live PUT /payments/settings/customers/{id}","title":"Update customer payment settings","href":"/reference/latest/collections/update-customer-payment-settings"},{"openapi":"collections.latest.product.live DELETE /payments/settings/customers/{id}","title":"Delete customer payment settings","href":"/reference/latest/collections/delete-customer-payment-settings"}]},{"group":"Invoices","pages":[{"openapi":"collections.latest.product.live POST /payments/settings/invoices","title":"Create invoice payment settings","href":"/reference/latest/collections/create-invoice-payment-settings"},{"openapi":"collections.latest.product.live GET /payments/settings/invoices/for-invoice/{id}","title":"Get invoice payment settings by invoice ID","href":"/reference/latest/collections/get-invoice-payment-settings-by-invoice-id"},{"openapi":"collections.latest.product.live GET /payments/settings/invoices/{id}","title":"Get invoice payment settings","href":"/reference/latest/collections/get-invoice-payment-settings"},{"openapi":"collections.latest.product.live PUT /payments/settings/invoices/{id}","title":"Update invoice payment settings","href":"/reference/latest/collections/update-invoice-payment-settings"},{"openapi":"collections.latest.product.live DELETE /payments/settings/invoices/{id}","title":"Delete invoice payment settings","href":"/reference/latest/collections/delete-invoice-payment-settings"}]},{"group":"Stripe Collection Settings","pages":[{"openapi":"collections.latest.product.live GET /stripe/collections/settings","title":"Stripe collection settings for Sequence account","href":"/reference/latest/collections/stripe-collection-settings-for-sequence-account"},{"openapi":"collections.latest.product.live PUT /stripe/collections/settings/{id}","title":"Update Stripe collection settings for Sequence account","href":"/reference/latest/collections/update-stripe-collection-settings-for-sequence-account"}]},{"group":"Account Settings","pages":[{"openapi":"collections.latest.product.live GET /payments/settings","title":"Payment settings for Sequence account","href":"/reference/latest/collections/payment-settings-for-sequence-account"},{"openapi":"collections.latest.product.live PUT /payments/settings/{id}","title":"Update payment settings for Sequence account","href":"/reference/latest/collections/update-payment-settings-for-sequence-account"}]}]},{"group":"Customer","pages":[{"group":"Customer Aliases","pages":[{"openapi":"customer.latest.product.live GET /customers/by-alias/{alias}","title":"Get customer by alias","href":"/reference/latest/customer/get-customer-by-alias"},{"openapi":"customer.latest.product.live GET /customers/{id}/aliases","title":"Get Customer Aliases","href":"/reference/latest/customer/get-customer-aliases"},{"openapi":"customer.latest.product.live PUT /customer-aliases/{id}","title":"Update a Customer Alias","href":"/reference/latest/customer/update-a-customer-alias"},{"openapi":"customer.latest.product.live DELETE /customer-aliases/{id}","title":"Delete a Customer Alias","href":"/reference/latest/customer/delete-a-customer-alias"},{"openapi":"customer.latest.product.live GET /customer-aliases","title":"List all Customer Aliases","href":"/reference/latest/customer/list-all-customer-aliases"},{"openapi":"customer.latest.product.live POST /customer-aliases","title":"Create a new Customer Alias","href":"/reference/latest/customer/create-a-new-customer-alias"}]},{"group":"Contacts","pages":[{"openapi":"customer.latest.product.live GET /customers/{customer}/contacts","title":"List all contacts for a customer","href":"/reference/latest/customer/list-all-contacts-for-a-customer"},{"openapi":"customer.latest.product.live POST /customers/{customer}/contacts","title":"Create a new contact","href":"/reference/latest/customer/create-a-new-contact"},{"openapi":"customer.latest.product.live POST /customers/{customer}/contacts/{id}/archive","title":"Archive a contact","href":"/reference/latest/customer/archive-a-contact"},{"openapi":"customer.latest.product.live PUT /customers/{customer}/contacts/{id}","title":"Update a contact","href":"/reference/latest/customer/update-a-contact"}]},{"group":"Customers","pages":[{"openapi":"customer.latest.product.live GET /customers/{id}","title":"Get customer","href":"/reference/latest/customer/get-customer"},{"openapi":"customer.latest.product.live PUT /customers/{id}","title":"Update customer","href":"/reference/latest/customer/update-customer"},{"openapi":"customer.latest.product.live GET /customer-custom-property-keys","title":"List customer custom property keys","href":"/reference/latest/customer/list-customer-custom-property-keys"},{"openapi":"customer.latest.product.live GET /customers","title":"List customers","href":"/reference/latest/customer/list-customers"},{"openapi":"customer.latest.product.live POST /customers","title":"Create customer","href":"/reference/latest/customer/create-customer"},{"openapi":"customer.latest.product.live POST /customers/{id}/archive","title":"Archive customer","href":"/reference/latest/customer/archive-customer"}]},{"group":"Organizations","pages":[{"openapi":"customer.latest.product.live PUT /customer-organizations/{id}/members","title":"Replace members of a customer organization","href":"/reference/latest/customer/replace-members-of-a-customer-organization"},{"openapi":"customer.latest.product.live POST /customer-organizations/{id}/members","title":"Add a customer to a customer organization","href":"/reference/latest/customer/add-a-customer-to-a-customer-organization"},{"openapi":"customer.latest.product.live POST /customer-organizations","title":"Create a customer organization","href":"/reference/latest/customer/create-a-customer-organization"}]}]},{"group":"Invoices","pages":[{"group":"Credit Notes","pages":[{"openapi":"invoices.latest.product.live GET /credit-notes","title":"List all Credit Notes","href":"/reference/latest/invoices/list-all-credit-notes"},{"openapi":"invoices.latest.product.live POST /credit-notes","title":"Create a new Credit Note","href":"/reference/latest/invoices/create-a-new-credit-note"},{"openapi":"invoices.latest.product.live GET /credit-notes/{id}","title":"Get a Credit Note by ID","href":"/reference/latest/invoices/get-a-credit-note-by-id"},{"openapi":"invoices.latest.product.live PUT /credit-notes/{id}","title":"Update a Credit Note","href":"/reference/latest/invoices/update-a-credit-note"},{"openapi":"invoices.latest.product.live DELETE /credit-notes/{id}","title":"Delete a Credit Note","href":"/reference/latest/invoices/delete-a-credit-note"},{"openapi":"invoices.latest.product.live POST /credit-notes/{id}/finalize-and-send","title":"Finalize and send credit note","href":"/reference/latest/invoices/finalize-and-send-credit-note"},{"openapi":"invoices.latest.product.live POST /credit-notes/{id}/send","title":"Send credit note","href":"/reference/latest/invoices/send-credit-note"},{"openapi":"invoices.latest.product.live GET /credit-notes/{id}/download","title":"Download credit note PDF","href":"/reference/latest/invoices/download-credit-note-pdf"},{"openapi":"invoices.latest.product.live POST /credit-notes/{id}/mark-as-sent","title":"Mark credit note as sent without triggering actions except revenue recognition","href":"/reference/latest/invoices/mark-credit-note-as-sent-without-triggering-actions-except-revenue-recognition"},{"openapi":"invoices.latest.product.live POST /credit-note-applications","title":"Apply a Credit Note to an Invoice","href":"/reference/latest/invoices/apply-a-credit-note-to-an-invoice"},{"openapi":"invoices.latest.product.live POST /credit-notes/{id}/finalize","title":"Finalize credit note","href":"/reference/latest/invoices/finalize-credit-note"},{"openapi":"invoices.latest.product.live POST /credit-notes/{id}/void","title":"Void a Credit Note","href":"/reference/latest/invoices/void-a-credit-note"}]},{"group":"Invoices","pages":[{"openapi":"invoices.latest.product.live GET /invoices","title":"List all Invoices","href":"/reference/latest/invoices/list-all-invoices"},{"openapi":"invoices.latest.product.live POST /invoices","title":"Create an invoice","href":"/reference/latest/invoices/create-an-invoice"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/send-payment-reminder","title":"Send a payment reminder for an invoice","href":"/reference/latest/invoices/send-a-payment-reminder-for-an-invoice"},{"openapi":"invoices.latest.product.live GET /invoices/{id}","title":"Get an Invoice by ID","href":"/reference/latest/invoices/get-an-invoice-by-id"},{"openapi":"invoices.latest.product.live PUT /invoices/{id}","title":"Update an invoice","href":"/reference/latest/invoices/update-an-invoice"},{"openapi":"invoices.latest.product.live DELETE /invoices/{id}","title":"Delete an Invoice","href":"/reference/latest/invoices/delete-an-invoice"},{"openapi":"invoices.latest.product.live PATCH /invoices/{id}","title":"Patch an invoice","href":"/reference/latest/invoices/patch-an-invoice"},{"openapi":"invoices.latest.product.live GET /invoices/list-summary","title":"List Invoice summaries","href":"/reference/latest/invoices/list-invoice-summaries"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/finalize-and-send","title":"Finalize and send invoice","href":"/reference/latest/invoices/finalize-and-send-invoice"},{"openapi":"invoices.latest.product.live POST /invoices/reconcile-with-integration","title":"Reconcile invoices with external integration","href":"/reference/latest/invoices/reconcile-invoices-with-external-integration"},{"openapi":"invoices.latest.product.live POST /invoices/merge","title":"Merge invoices","href":"/reference/latest/invoices/merge-invoices"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/finalize","title":"Finalize invoice","href":"/reference/latest/invoices/finalize-invoice"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/void","title":"Void an Invoice","href":"/reference/latest/invoices/void-an-invoice"},{"openapi":"invoices.latest.product.live GET /invoices/summary","title":"Get an invoice summary","href":"/reference/latest/invoices/get-an-invoice-summary"},{"openapi":"invoices.latest.product.live POST /invoices/fix-billing-runs","title":"Fix invoices billing runs","href":"/reference/latest/invoices/fix-invoices-billing-runs"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/draft","title":"Convert upcoming invoice to draft","href":"/reference/latest/invoices/convert-upcoming-invoice-to-draft"},{"openapi":"invoices.latest.product.live GET /invoices/{id}/download","title":"Download invoice PDF","href":"/reference/latest/invoices/download-invoice-pdf"},{"openapi":"invoices.latest.product.live PUT /invoices/{id}/payment-status","title":"Update payment status for an invoice","href":"/reference/latest/invoices/update-payment-status-for-an-invoice"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/mark-as-sent","title":"Finalize and mark invoice as sent without triggering actions except revenue recognition","href":"/reference/latest/invoices/finalize-and-mark-invoice-as-sent-without-triggering-actions-except-revenue-recognition"},{"openapi":"invoices.latest.product.live PATCH /invoices/{id}/sent","title":"Patch a sent invoice","href":"/reference/latest/invoices/patch-a-sent-invoice"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/send","title":"Send invoice","href":"/reference/latest/invoices/send-invoice"},{"openapi":"invoices.latest.product.live GET /invoices/{id}/currency-conversions","title":"List Currency Conversions for an Invoice","href":"/reference/latest/invoices/list-currency-conversions-for-an-invoice"}]},{"group":"Invoice Line Items","pages":[{"openapi":"invoices.latest.product.live GET /invoices/{invoice}/line-items","title":"List all Line Items","href":"/reference/latest/invoices/list-all-line-items"},{"openapi":"invoices.latest.product.live POST /invoices/{invoice}/line-items","title":"Create a new Line Item","href":"/reference/latest/invoices/create-a-new-line-item"},{"openapi":"invoices.latest.product.live PUT /invoices/{invoice}/line-items/{id}","title":"Update a line item","href":"/reference/latest/invoices/update-a-line-item"},{"openapi":"invoices.latest.product.live DELETE /invoices/{invoice}/line-items/{id}","title":"Deletes a Line Item","href":"/reference/latest/invoices/deletes-a-line-item"},{"openapi":"invoices.latest.product.live PUT /invoices/{invoice}/line-item-groups/{id}","title":"Update a Line Item Group","href":"/reference/latest/invoices/update-a-line-item-group"},{"openapi":"invoices.latest.product.live DELETE /invoices/{invoice}/line-item-groups/{id}","title":"Delete a Line Item Group","href":"/reference/latest/invoices/delete-a-line-item-group"},{"openapi":"invoices.latest.product.live GET /invoices/{invoice}/line-item-groups","title":"List all Line Item Groups","href":"/reference/latest/invoices/list-all-line-item-groups"},{"openapi":"invoices.latest.product.live POST /invoices/{invoice}/line-item-groups","title":"Create a new Line Item Group","href":"/reference/latest/invoices/create-a-new-line-item-group"}]},{"group":"Invoice Settings","pages":[{"openapi":"invoices.latest.product.live GET /invoices/render-settings","title":"Get or create Invoice Render Settings","href":"/reference/latest/invoices/get-or-create-invoice-render-settings"},{"openapi":"invoices.latest.product.live PUT /invoices/render-settings/{id}","title":"Update an Invoice Render Settings","href":"/reference/latest/invoices/update-an-invoice-render-settings"}]},{"group":"Credit Note Line Items","pages":[{"openapi":"invoices.latest.product.live PUT /credit-notes/{creditnote}/line-item-groups/{id}","title":"Update a Credit Note Line Item Group","href":"/reference/latest/invoices/update-a-credit-note-line-item-group"},{"openapi":"invoices.latest.product.live DELETE /credit-notes/{creditnote}/line-item-groups/{id}","title":"Delete a Credit Note Line Item Group","href":"/reference/latest/invoices/delete-a-credit-note-line-item-group"},{"openapi":"invoices.latest.product.live GET /credit-notes/{creditnote}/line-item-groups","title":"List all Credit Note Line Item Groups","href":"/reference/latest/invoices/list-all-credit-note-line-item-groups"},{"openapi":"invoices.latest.product.live POST /credit-notes/{creditnote}/line-item-groups","title":"Create a new Credit Note Line Item Group","href":"/reference/latest/invoices/create-a-new-credit-note-line-item-group"},{"openapi":"invoices.latest.product.live GET /credit-notes/{creditnote}/line-items","title":"List all Credit Note Line Items","href":"/reference/latest/invoices/list-all-credit-note-line-items"},{"openapi":"invoices.latest.product.live POST /credit-notes/{creditnote}/line-items","title":"Create a new Credit Note Line Item","href":"/reference/latest/invoices/create-a-new-credit-note-line-item"},{"openapi":"invoices.latest.product.live PUT /credit-notes/{creditnote}/line-items/{id}","title":"Update a Credit Note Line Item","href":"/reference/latest/invoices/update-a-credit-note-line-item"},{"openapi":"invoices.latest.product.live DELETE /credit-notes/{creditnote}/line-items/{id}","title":"Delete a Credit Note Line Item","href":"/reference/latest/invoices/delete-a-credit-note-line-item"}]}]},{"group":"Notifications","pages":[{"group":"Notification Policies","pages":[{"openapi":"notifications.latest.product.live POST /notifications/policies/{id}/recipients","title":"Add recipients to a policy","href":"/reference/latest/notifications/add-recipients-to-a-policy"},{"openapi":"notifications.latest.product.live POST /notifications/policies/{id}/notification-types","title":"Add notification types to a policy","href":"/reference/latest/notifications/add-notification-types-to-a-policy"},{"openapi":"notifications.latest.product.live DELETE /notifications/policies/{id}/notification-types/{type}","title":"Remove a notification type from a policy","href":"/reference/latest/notifications/remove-a-notification-type-from-a-policy"},{"openapi":"notifications.latest.product.live GET /notifications/policies","title":"List All Notification Policies","href":"/reference/latest/notifications/list-all-notification-policies"},{"openapi":"notifications.latest.product.live POST /notifications/policies","title":"Create Notification policy","href":"/reference/latest/notifications/create-notification-policy"},{"openapi":"notifications.latest.product.live GET /notifications/policies/{id}","title":"Get notification policy","href":"/reference/latest/notifications/get-notification-policy"},{"openapi":"notifications.latest.product.live DELETE /notifications/policies/{id}","title":"Delete notification policy","href":"/reference/latest/notifications/delete-notification-policy"},{"openapi":"notifications.latest.product.live DELETE /notifications/policies/{id}/recipients/{recipient}","title":"Remove a recipient from a policy","href":"/reference/latest/notifications/remove-a-recipient-from-a-policy"}]}]},{"group":"Orchestra","pages":[{"group":"Assets","pages":[{"openapi":"orchestra.latest.product.live POST /assets","title":"Upload an asset","href":"/reference/latest/orchestra/upload-an-asset"},{"openapi":"orchestra.latest.product.live GET /assets/{id}","title":"Get an asset","href":"/reference/latest/orchestra/get-an-asset"}]}]},{"group":"Product","pages":[{"group":"Products","pages":[{"openapi":"product.latest.product.live POST /products/{id}/archive","title":"Archive a product","href":"/reference/latest/product/archive-a-product"},{"openapi":"product.latest.product.live GET /products/{id}","title":"Get a Product by ID","href":"/reference/latest/product/get-a-product-by-id"},{"openapi":"product.latest.product.live PUT /products/{id}","title":"Update a Product","href":"/reference/latest/product/update-a-product"},{"openapi":"product.latest.product.live GET /products","title":"List all Products","href":"/reference/latest/product/list-all-products"},{"openapi":"product.latest.product.live POST /products","title":"Create a new Product","href":"/reference/latest/product/create-a-new-product"}]},{"group":"List Prices","pages":[{"openapi":"product.latest.product.live GET /list-prices/{id}","title":"Get a list price","href":"/reference/latest/product/get-a-list-price"},{"openapi":"product.latest.product.live PUT /list-prices/{id}","title":"Update a list price","href":"/reference/latest/product/update-a-list-price"},{"openapi":"product.latest.product.live POST /list-prices/{id}/archive","title":"Archive a list price","href":"/reference/latest/product/archive-a-list-price"},{"openapi":"product.latest.product.live GET /list-prices","title":"List all list prices","href":"/reference/latest/product/list-all-list-prices"},{"openapi":"product.latest.product.live POST /list-prices","title":"Create a list price","href":"/reference/latest/product/create-a-list-price"}]}]},{"group":"Quote","pages":[{"group":"Quotes","pages":[{"openapi":"quote.latest.product.live POST /quotes/{quoteId}/send-reminders","title":"Send reminder emails to all that have not signed.","href":"/reference/latest/quote/send-reminder-emails-to-all-that-have-not-signed."},{"openapi":"quote.latest.product.live GET /quotes/{id}","title":"Get one of your quotes","href":"/reference/latest/quote/get-one-of-your-quotes"},{"openapi":"quote.latest.product.live PUT /quotes/{id}","title":"Update one of your quotes","href":"/reference/latest/quote/update-one-of-your-quotes"},{"openapi":"quote.latest.product.live GET /quotes/{id}/analytics","title":"Get quote analytics","href":"/reference/latest/quote/get-quote-analytics"},{"openapi":"quote.latest.product.live POST /quotes/from-template/{id}","title":"Create a quote from a template","href":"/reference/latest/quote/create-a-quote-from-a-template"},{"openapi":"quote.latest.product.live POST /quotes/{id}/archive","title":"Archive a quote","href":"/reference/latest/quote/archive-a-quote"},{"openapi":"quote.latest.product.live GET /quotes/{id}/published","title":"Get a published quote","href":"/reference/latest/quote/get-a-published-quote"},{"openapi":"quote.latest.product.live GET /quotes","title":"List quotes","href":"/reference/latest/quote/list-quotes"},{"openapi":"quote.latest.product.live GET /quotes/{id}/download","title":"Download quote PDF","href":"/reference/latest/quote/download-quote-pdf"},{"openapi":"quote.latest.product.live POST /quotes/{quoteId}/notify-recipients","title":"Notify selected quote recipients by email","href":"/reference/latest/quote/notify-selected-quote-recipients-by-email"},{"openapi":"quote.latest.product.live POST /quotes/{id}/accept","title":"Accept a published Quote","href":"/reference/latest/quote/accept-a-published-quote"},{"openapi":"quote.latest.product.live POST /quotes/{id}/publish","title":"Publish a quote","href":"/reference/latest/quote/publish-a-quote"}]},{"group":"Quote Templates","pages":[{"openapi":"quote.latest.product.live GET /quote-templates","title":"List quote templates","href":"/reference/latest/quote/list-quote-templates"}]}]},{"group":"Taxes","pages":[{"group":"Tax Rates","pages":[{"openapi":"taxes.latest.product.live GET /tax-rates","title":"List all Tax Rates","href":"/reference/latest/taxes/list-all-tax-rates"},{"openapi":"taxes.latest.product.live POST /tax-rates","title":"Create a new TaxRate","href":"/reference/latest/taxes/create-a-new-taxrate"},{"openapi":"taxes.latest.product.live GET /tax-rates/{id}","title":"Get a Tax Rate by ID","href":"/reference/latest/taxes/get-a-tax-rate-by-id"},{"openapi":"taxes.latest.product.live PUT /tax-rates/{id}","title":"Update a TaxRate","href":"/reference/latest/taxes/update-a-taxrate"},{"openapi":"taxes.latest.product.live DELETE /tax-rates/{id}","title":"Delete a Tax Rate","href":"/reference/latest/taxes/delete-a-tax-rate"},{"openapi":"taxes.latest.product.live POST /tax-rates/{id}/archive","title":"Archive a tax rate","href":"/reference/latest/taxes/archive-a-tax-rate"}]},{"group":"Tax Registrations","pages":[{"openapi":"taxes.latest.product.live GET /tax-registrations","title":"List all Tax Registrations","href":"/reference/latest/taxes/list-all-tax-registrations"},{"openapi":"taxes.latest.product.live POST /tax-registrations","title":"Create a new Tax Registration","href":"/reference/latest/taxes/create-a-new-tax-registration"},{"openapi":"taxes.latest.product.live GET /tax-registrations/for-customer/{id}","title":"Get all tax registrations for a customer by customer ID","href":"/reference/latest/taxes/get-all-tax-registrations-for-a-customer-by-customer-id"},{"openapi":"taxes.latest.product.live GET /tax-registrations/for-merchant/{id}","title":"Get all tax registrations for a merchant by merchant ID","href":"/reference/latest/taxes/get-all-tax-registrations-for-a-merchant-by-merchant-id"},{"openapi":"taxes.latest.product.live GET /tax-registrations/{id}","title":"Get a Tax Registration by ID","href":"/reference/latest/taxes/get-a-tax-registration-by-id"},{"openapi":"taxes.latest.product.live PUT /tax-registrations/{id}","title":"Update a Tax Registration","href":"/reference/latest/taxes/update-a-tax-registration"},{"openapi":"taxes.latest.product.live DELETE /tax-registrations/{id}","title":"Delete a Tax Registration","href":"/reference/latest/taxes/delete-a-tax-registration"}]}]},{"group":"Usage","pages":[{"group":"Usage Events","pages":[{"openapi":"usage.latest.product.live GET /usage-events","title":"List all Usage Events","href":"/reference/latest/usage/list-all-usage-events"},{"openapi":"usage.latest.product.live POST /usage-events","title":"Create a new Usage Event","href":"/reference/latest/usage/create-a-new-usage-event"}]},{"group":"Seat Metrics","pages":[{"openapi":"usage.latest.product.live GET /seat-metrics","title":"List all seat metrics","href":"/reference/latest/usage/list-all-seat-metrics"},{"openapi":"usage.latest.product.live POST /seat-metrics","title":"Create a seat metric","href":"/reference/latest/usage/create-a-seat-metric"},{"openapi":"usage.latest.product.live GET /seat-metrics/{id}","title":"Get a seat metric","href":"/reference/latest/usage/get-a-seat-metric"},{"openapi":"usage.latest.product.live PUT /seat-metrics/{id}","title":"Update a seat metric","href":"/reference/latest/usage/update-a-seat-metric"},{"openapi":"usage.latest.product.live DELETE /seat-metrics/{id}","title":"Delete a seat metric","href":"/reference/latest/usage/delete-a-seat-metric"},{"openapi":"usage.latest.product.live GET /seat-balances","title":"List Seat balances by Customer","href":"/reference/latest/usage/list-seat-balances-by-customer"}]},{"group":"Seat Events","pages":[{"openapi":"usage.latest.product.live GET /seat-events","title":"List all seat events","href":"/reference/latest/usage/list-all-seat-events"},{"openapi":"usage.latest.product.live POST /seat-events","title":"Create a seat event","href":"/reference/latest/usage/create-a-seat-event"},{"openapi":"usage.latest.product.live GET /seat-events/{id}","title":"Get a seat event by ID","href":"/reference/latest/usage/get-a-seat-event-by-id"}]},{"group":"Usage Metrics","pages":[{"openapi":"usage.latest.product.live POST /usage-metrics","title":"Create a new Usage Metric","href":"/reference/latest/usage/create-a-new-usage-metric"},{"openapi":"usage.latest.product.live GET /usage-metrics","title":"List all Usage Metrics","href":"/reference/latest/usage/list-all-usage-metrics"},{"openapi":"usage.latest.product.live GET /usage-metrics/{id}","title":"Get a Usage Metric by ID","href":"/reference/latest/usage/get-a-usage-metric-by-id"},{"openapi":"usage.latest.product.live PUT /usage-metrics/{id}","title":"Update a Usage Metric","href":"/reference/latest/usage/update-a-usage-metric"},{"openapi":"usage.latest.product.live DELETE /usage-metrics/{id}","title":"Delete a Usage Metric","href":"/reference/latest/usage/delete-a-usage-metric"},{"openapi":"usage.latest.product.live GET /usage-metrics/{usageMetricId}/calculate","title":"Calculate usage metric for customer and timeframe","href":"/reference/latest/usage/calculate-usage-metric-for-customer-and-timeframe"}]}]}]},{"group":"Version 2024-07-30","pages":[{"group":"Account","pages":[{"group":"Accounts","pages":[{"openapi":"account.2024-07-30.product.live GET /sequence-accounts","title":"List your accounts","href":"/reference/2024-07-30/account/list-your-accounts"},{"openapi":"account.2024-07-30.product.live GET /sequence-accounts/{id}","title":"Get your account","href":"/reference/2024-07-30/account/get-your-account"},{"openapi":"account.2024-07-30.product.live PUT /sequence-accounts/{id}","title":"Update Account","href":"/reference/2024-07-30/account/update-account"}]},{"group":"Users","pages":[{"openapi":"account.2024-07-30.product.live GET /users/{id}","title":"Get a user","href":"/reference/2024-07-30/account/get-a-user"},{"openapi":"account.2024-07-30.product.live DELETE /users/{id}","title":"Delete User","href":"/reference/2024-07-30/account/delete-user"},{"openapi":"account.2024-07-30.product.live GET /users","title":"List all Users","href":"/reference/2024-07-30/account/list-all-users"}]}]},{"group":"Activity Stream","pages":[{"group":"Activities","pages":[{"openapi":"activity-stream.2024-07-30.product.live GET /activity-logs/{id}","title":"Get an Activity Log by ID","href":"/reference/2024-07-30/activity-stream/get-an-activity-log-by-id"},{"openapi":"activity-stream.2024-07-30.product.live GET /activity-logs","title":"List all Activity Logs","href":"/reference/2024-07-30/activity-stream/list-all-activity-logs"}]}]},{"group":"Billing","pages":[{"group":"Prices","pages":[{"openapi":"billing.2024-07-30.product.live GET /prices","title":"List all Prices","href":"/reference/2024-07-30/billing/list-all-prices"},{"openapi":"billing.2024-07-30.product.live POST /prices","title":"Create a new Price","href":"/reference/2024-07-30/billing/create-a-new-price"},{"openapi":"billing.2024-07-30.product.live GET /prices/{id}","title":"Get a Price by ID","href":"/reference/2024-07-30/billing/get-a-price-by-id"},{"openapi":"billing.2024-07-30.product.live PUT /prices/{id}","title":"Update a Price","href":"/reference/2024-07-30/billing/update-a-price"},{"openapi":"billing.2024-07-30.product.live DELETE /prices/{id}","title":"Delete a Price","href":"/reference/2024-07-30/billing/delete-a-price"},{"openapi":"billing.2024-07-30.product.live GET /billing-products","title":"List all billing products","href":"/reference/2024-07-30/billing/list-all-billing-products"}]},{"group":"Discounts","pages":[{"openapi":"billing.2024-07-30.product.live GET /discounts/{id}","title":"Get a discount by ID","href":"/reference/2024-07-30/billing/get-a-discount-by-id"},{"openapi":"billing.2024-07-30.product.live PUT /discounts/{id}","title":"Update a discount","href":"/reference/2024-07-30/billing/update-a-discount"},{"openapi":"billing.2024-07-30.product.live DELETE /discounts/{id}","title":"Delete a discount","href":"/reference/2024-07-30/billing/delete-a-discount"},{"openapi":"billing.2024-07-30.product.live GET /discounts","title":"List all discounts","href":"/reference/2024-07-30/billing/list-all-discounts"}]},{"group":"Billing Schedules","pages":[{"openapi":"billing.2024-07-30.product.live POST /billing-schedules/{billingScheduleId}/duplicate","title":"Duplicate a billing schedule","href":"/reference/2024-07-30/billing/duplicate-a-billing-schedule"},{"openapi":"billing.2024-07-30.product.live GET /billing-schedules","title":"List all Billing Schedules","href":"/reference/2024-07-30/billing/list-all-billing-schedules"},{"openapi":"billing.2024-07-30.product.live POST /billing-schedules","title":"Create Billing Schedule","href":"/reference/2024-07-30/billing/create-billing-schedule"},{"openapi":"billing.2024-07-30.product.live POST /billing-schedules/validate-taxes","title":"Validate taxes on a billing schedule","href":"/reference/2024-07-30/billing/validate-taxes-on-a-billing-schedule"},{"openapi":"billing.2024-07-30.product.live GET /billing-schedules/{billingScheduleId}","title":"Get Billing Schedule","href":"/reference/2024-07-30/billing/get-billing-schedule"},{"openapi":"billing.2024-07-30.product.live PUT /billing-schedules/{billingScheduleId}","title":"Update Billing Schedule","href":"/reference/2024-07-30/billing/update-billing-schedule"},{"openapi":"billing.2024-07-30.product.live POST /billing-schedules/{billingScheduleId}/archive","title":"Archive Billing Schedule","href":"/reference/2024-07-30/billing/archive-billing-schedule"},{"openapi":"billing.2024-07-30.product.live PUT /billing-schedules/{billingScheduleId}/activate","title":"Activate Billing Schedule","href":"/reference/2024-07-30/billing/activate-billing-schedule"},{"openapi":"billing.2024-07-30.product.live GET /billing-schedule-custom-field-keys","title":"List Billing Schedule Custom Field Keys","href":"/reference/2024-07-30/billing/list-billing-schedule-custom-field-keys"}]},{"group":"Credits","pages":[{"openapi":"billing.2024-07-30.product.live GET /credit-grants/{id}","title":"Get a credit grant","href":"/reference/2024-07-30/billing/get-a-credit-grant"},{"openapi":"billing.2024-07-30.product.live GET /credits/{customerId}/grants","title":"List Credit Grants for a customer","href":"/reference/2024-07-30/billing/list-credit-grants-for-a-customer"},{"openapi":"billing.2024-07-30.product.live GET /credit-grants","title":"List credit grants","href":"/reference/2024-07-30/billing/list-credit-grants"},{"openapi":"billing.2024-07-30.product.live POST /credit-grants","title":"Create a customer credit grant","href":"/reference/2024-07-30/billing/create-a-customer-credit-grant"},{"openapi":"billing.2024-07-30.product.live GET /credits","title":"List customer credit grants","href":"/reference/2024-07-30/billing/list-customer-credit-grants"},{"openapi":"billing.2024-07-30.product.live POST /credits","title":"Create a new credit grant","href":"/reference/2024-07-30/billing/create-a-new-credit-grant"},{"openapi":"billing.2024-07-30.product.live GET /credits/{id}","title":"Get a customer credit grant","href":"/reference/2024-07-30/billing/get-a-customer-credit-grant"},{"openapi":"billing.2024-07-30.product.live DELETE /credits/{id}","title":"Delete a credit grant","href":"/reference/2024-07-30/billing/delete-a-credit-grant"},{"openapi":"billing.2024-07-30.product.live GET /credits/{customerId}/balances","title":"List Credit Balances for a customer","href":"/reference/2024-07-30/billing/list-credit-balances-for-a-customer"}]}]},{"group":"Collections","pages":[{"group":"Billing Schedules","pages":[{"openapi":"collections.2024-07-30.product.live GET /payments/settings/billing-schedules/{id}","title":"Get billing schedule payment settings","href":"/reference/2024-07-30/collections/get-billing-schedule-payment-settings"},{"openapi":"collections.2024-07-30.product.live PUT /payments/settings/billing-schedules/{id}","title":"Update billing schedule payment settings","href":"/reference/2024-07-30/collections/update-billing-schedule-payment-settings"},{"openapi":"collections.2024-07-30.product.live DELETE /payments/settings/billing-schedules/{id}","title":"Delete billing schedule payment settings","href":"/reference/2024-07-30/collections/delete-billing-schedule-payment-settings"},{"openapi":"collections.2024-07-30.product.live GET /payments/settings/billing-schedules/for-billing-schedule/{id}","title":"Get billing schedule payment settings by billing schedule ID","href":"/reference/2024-07-30/collections/get-billing-schedule-payment-settings-by-billing-schedule-id"},{"openapi":"collections.2024-07-30.product.live POST /payments/settings/billing-schedules","title":"Create billing schedule payment settings","href":"/reference/2024-07-30/collections/create-billing-schedule-payment-settings"}]},{"group":"Customers","pages":[{"openapi":"collections.2024-07-30.product.live POST /payments/settings/customers","title":"Create customer payment settings","href":"/reference/2024-07-30/collections/create-customer-payment-settings"},{"openapi":"collections.2024-07-30.product.live GET /payments/settings/customers/{id}","title":"Get customer payment settings","href":"/reference/2024-07-30/collections/get-customer-payment-settings"},{"openapi":"collections.2024-07-30.product.live PUT /payments/settings/customers/{id}","title":"Update customer payment settings","href":"/reference/2024-07-30/collections/update-customer-payment-settings"},{"openapi":"collections.2024-07-30.product.live DELETE /payments/settings/customers/{id}","title":"Delete customer payment settings","href":"/reference/2024-07-30/collections/delete-customer-payment-settings"}]},{"group":"Invoices","pages":[{"openapi":"collections.2024-07-30.product.live POST /payments/settings/invoices","title":"Create invoice payment settings","href":"/reference/2024-07-30/collections/create-invoice-payment-settings"},{"openapi":"collections.2024-07-30.product.live GET /payments/settings/invoices/for-invoice/{id}","title":"Get invoice payment settings by invoice ID","href":"/reference/2024-07-30/collections/get-invoice-payment-settings-by-invoice-id"},{"openapi":"collections.2024-07-30.product.live GET /payments/settings/invoices/{id}","title":"Get invoice payment settings","href":"/reference/2024-07-30/collections/get-invoice-payment-settings"},{"openapi":"collections.2024-07-30.product.live PUT /payments/settings/invoices/{id}","title":"Update invoice payment settings","href":"/reference/2024-07-30/collections/update-invoice-payment-settings"},{"openapi":"collections.2024-07-30.product.live DELETE /payments/settings/invoices/{id}","title":"Delete invoice payment settings","href":"/reference/2024-07-30/collections/delete-invoice-payment-settings"}]},{"group":"Stripe Collection Settings","pages":[{"openapi":"collections.2024-07-30.product.live GET /stripe/collections/settings","title":"Stripe collection settings for Sequence account","href":"/reference/2024-07-30/collections/stripe-collection-settings-for-sequence-account"},{"openapi":"collections.2024-07-30.product.live PUT /stripe/collections/settings/{id}","title":"Update Stripe collection settings for Sequence account","href":"/reference/2024-07-30/collections/update-stripe-collection-settings-for-sequence-account"}]},{"group":"Account Settings","pages":[{"openapi":"collections.2024-07-30.product.live GET /payments/settings","title":"Payment settings for Sequence account","href":"/reference/2024-07-30/collections/payment-settings-for-sequence-account"},{"openapi":"collections.2024-07-30.product.live PUT /payments/settings/{id}","title":"Update payment settings for Sequence account","href":"/reference/2024-07-30/collections/update-payment-settings-for-sequence-account"}]}]},{"group":"Customer","pages":[{"group":"Customer Aliases","pages":[{"openapi":"customer.2024-07-30.product.live GET /customers/by-alias/{alias}","title":"Get customer by alias","href":"/reference/2024-07-30/customer/get-customer-by-alias"},{"openapi":"customer.2024-07-30.product.live GET /customers/{id}/aliases","title":"Get Customer Aliases","href":"/reference/2024-07-30/customer/get-customer-aliases"},{"openapi":"customer.2024-07-30.product.live PUT /customer-aliases/{id}","title":"Update a Customer Alias","href":"/reference/2024-07-30/customer/update-a-customer-alias"},{"openapi":"customer.2024-07-30.product.live DELETE /customer-aliases/{id}","title":"Delete a Customer Alias","href":"/reference/2024-07-30/customer/delete-a-customer-alias"},{"openapi":"customer.2024-07-30.product.live GET /customer-aliases","title":"List all Customer Aliases","href":"/reference/2024-07-30/customer/list-all-customer-aliases"},{"openapi":"customer.2024-07-30.product.live POST /customer-aliases","title":"Create a new Customer Alias","href":"/reference/2024-07-30/customer/create-a-new-customer-alias"}]},{"group":"Contacts","pages":[{"openapi":"customer.2024-07-30.product.live GET /customers/{customer}/contacts","title":"List all contacts for a customer","href":"/reference/2024-07-30/customer/list-all-contacts-for-a-customer"},{"openapi":"customer.2024-07-30.product.live POST /customers/{customer}/contacts","title":"Create a new contact","href":"/reference/2024-07-30/customer/create-a-new-contact"},{"openapi":"customer.2024-07-30.product.live POST /customers/{customer}/contacts/{id}/archive","title":"Archive a contact","href":"/reference/2024-07-30/customer/archive-a-contact"},{"openapi":"customer.2024-07-30.product.live PUT /customers/{customer}/contacts/{id}","title":"Update a contact","href":"/reference/2024-07-30/customer/update-a-contact"}]},{"group":"Customers","pages":[{"openapi":"customer.2024-07-30.product.live GET /customers/{id}","title":"Get customer","href":"/reference/2024-07-30/customer/get-customer"},{"openapi":"customer.2024-07-30.product.live PUT /customers/{id}","title":"Update customer","href":"/reference/2024-07-30/customer/update-customer"},{"openapi":"customer.2024-07-30.product.live GET /customer-custom-property-keys","title":"List customer custom property keys","href":"/reference/2024-07-30/customer/list-customer-custom-property-keys"},{"openapi":"customer.2024-07-30.product.live GET /customers","title":"List customers","href":"/reference/2024-07-30/customer/list-customers"},{"openapi":"customer.2024-07-30.product.live POST /customers","title":"Create customer","href":"/reference/2024-07-30/customer/create-customer"},{"openapi":"customer.2024-07-30.product.live POST /customers/{id}/archive","title":"Archive customer","href":"/reference/2024-07-30/customer/archive-customer"}]},{"group":"Organizations","pages":[{"openapi":"customer.2024-07-30.product.live PUT /customer-organizations/{id}/members","title":"Replace members of a customer organization","href":"/reference/2024-07-30/customer/replace-members-of-a-customer-organization"},{"openapi":"customer.2024-07-30.product.live POST /customer-organizations/{id}/members","title":"Add a customer to a customer organization","href":"/reference/2024-07-30/customer/add-a-customer-to-a-customer-organization"},{"openapi":"customer.2024-07-30.product.live POST /customer-organizations","title":"Create a customer organization","description":"Create a customer organization to manage parent-child relationships for your [customers](/customers/overview).","href":"/reference/2024-07-30/customer/create-a-customer-organization"}]}]},{"group":"Invoices","pages":[{"group":"Credit Notes","pages":[{"openapi":"invoices.2024-07-30.product.live GET /credit-notes","title":"List all Credit Notes","href":"/reference/2024-07-30/invoices/list-all-credit-notes"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes","title":"Create a new Credit Note","description":"Create a new Credit Note","href":"/reference/2024-07-30/invoices/create-a-new-credit-note"},{"openapi":"invoices.2024-07-30.product.live GET /credit-notes/{id}","title":"Get a Credit Note by ID","href":"/reference/2024-07-30/invoices/get-a-credit-note-by-id"},{"openapi":"invoices.2024-07-30.product.live PUT /credit-notes/{id}","title":"Update a Credit Note","href":"/reference/2024-07-30/invoices/update-a-credit-note"},{"openapi":"invoices.2024-07-30.product.live DELETE /credit-notes/{id}","title":"Delete a Credit Note","href":"/reference/2024-07-30/invoices/delete-a-credit-note"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{id}/finalize-and-send","title":"Finalize and send credit note","href":"/reference/2024-07-30/invoices/finalize-and-send-credit-note"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{id}/send","title":"Send credit note","href":"/reference/2024-07-30/invoices/send-credit-note"},{"openapi":"invoices.2024-07-30.product.live GET /credit-notes/{id}/download","title":"Download credit note PDF","href":"/reference/2024-07-30/invoices/download-credit-note-pdf"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{id}/mark-as-sent","title":"Mark credit note as sent without triggering actions except revenue recognition","href":"/reference/2024-07-30/invoices/mark-credit-note-as-sent-without-triggering-actions-except-revenue-recognition"},{"openapi":"invoices.2024-07-30.product.live POST /credit-note-applications","title":"Apply a Credit Note to an Invoice","href":"/reference/2024-07-30/invoices/apply-a-credit-note-to-an-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{id}/finalize","title":"Finalize credit note","href":"/reference/2024-07-30/invoices/finalize-credit-note"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{id}/void","title":"Void a Credit Note","href":"/reference/2024-07-30/invoices/void-a-credit-note"}]},{"group":"Invoices","pages":[{"openapi":"invoices.2024-07-30.product.live GET /invoices","title":"List all Invoices","href":"/reference/2024-07-30/invoices/list-all-invoices"},{"openapi":"invoices.2024-07-30.product.live POST /invoices","title":"Create an invoice","href":"/reference/2024-07-30/invoices/create-an-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/send-payment-reminder","title":"Send a payment reminder for an invoice","href":"/reference/2024-07-30/invoices/send-a-payment-reminder-for-an-invoice"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/{id}","title":"Get an Invoice by ID","href":"/reference/2024-07-30/invoices/get-an-invoice-by-id"},{"openapi":"invoices.2024-07-30.product.live PUT /invoices/{id}","title":"Update an invoice","href":"/reference/2024-07-30/invoices/update-an-invoice"},{"openapi":"invoices.2024-07-30.product.live DELETE /invoices/{id}","title":"Delete an Invoice","href":"/reference/2024-07-30/invoices/delete-an-invoice"},{"openapi":"invoices.2024-07-30.product.live PATCH /invoices/{id}","title":"Patch an invoice","href":"/reference/2024-07-30/invoices/patch-an-invoice"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/list-summary","title":"List Invoice summaries","href":"/reference/2024-07-30/invoices/list-invoice-summaries"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/finalize-and-send","title":"Finalize and send invoice","href":"/reference/2024-07-30/invoices/finalize-and-send-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/reconcile-with-integration","title":"Reconcile invoices with external integration","href":"/reference/2024-07-30/invoices/reconcile-invoices-with-external-integration"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/merge","title":"Merge invoices","href":"/reference/2024-07-30/invoices/merge-invoices"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/finalize","title":"Finalize invoice","href":"/reference/2024-07-30/invoices/finalize-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/void","title":"Void an Invoice","href":"/reference/2024-07-30/invoices/void-an-invoice"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/summary","title":"Get an invoice summary","href":"/reference/2024-07-30/invoices/get-an-invoice-summary"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/fix-billing-runs","title":"Fix invoices billing runs","href":"/reference/2024-07-30/invoices/fix-invoices-billing-runs"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/draft","title":"Convert upcoming invoice to draft","href":"/reference/2024-07-30/invoices/convert-upcoming-invoice-to-draft"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/{id}/download","title":"Download invoice PDF","href":"/reference/2024-07-30/invoices/download-invoice-pdf"},{"openapi":"invoices.2024-07-30.product.live PUT /invoices/{id}/payment-status","title":"Update payment status for an invoice","href":"/reference/2024-07-30/invoices/update-payment-status-for-an-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/mark-as-sent","title":"Finalize and mark invoice as sent without triggering actions except revenue recognition","href":"/reference/2024-07-30/invoices/finalize-and-mark-invoice-as-sent-without-triggering-actions-except-revenue-recognition"},{"openapi":"invoices.2024-07-30.product.live PATCH /invoices/{id}/sent","title":"Patch a sent invoice","href":"/reference/2024-07-30/invoices/patch-a-sent-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/send","title":"Send invoice","href":"/reference/2024-07-30/invoices/send-invoice"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/{id}/currency-conversions","title":"List Currency Conversions for an Invoice","href":"/reference/2024-07-30/invoices/list-currency-conversions-for-an-invoice"}]},{"group":"Invoice Line Items","pages":[{"openapi":"invoices.2024-07-30.product.live GET /invoices/{invoice}/line-items","title":"List all Line Items","href":"/reference/2024-07-30/invoices/list-all-line-items"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{invoice}/line-items","title":"Create a new Line Item","href":"/reference/2024-07-30/invoices/create-a-new-line-item"},{"openapi":"invoices.2024-07-30.product.live PUT /invoices/{invoice}/line-items/{id}","title":"Update a line item","href":"/reference/2024-07-30/invoices/update-a-line-item"},{"openapi":"invoices.2024-07-30.product.live DELETE /invoices/{invoice}/line-items/{id}","title":"Deletes a Line Item","href":"/reference/2024-07-30/invoices/deletes-a-line-item"},{"openapi":"invoices.2024-07-30.product.live PUT /invoices/{invoice}/line-item-groups/{id}","title":"Update a Line Item Group","href":"/reference/2024-07-30/invoices/update-a-line-item-group"},{"openapi":"invoices.2024-07-30.product.live DELETE /invoices/{invoice}/line-item-groups/{id}","title":"Delete a Line Item Group","href":"/reference/2024-07-30/invoices/delete-a-line-item-group"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/{invoice}/line-item-groups","title":"List all Line Item Groups","href":"/reference/2024-07-30/invoices/list-all-line-item-groups"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{invoice}/line-item-groups","title":"Create a new Line Item Group","href":"/reference/2024-07-30/invoices/create-a-new-line-item-group"}]},{"group":"Invoice Settings","pages":[{"openapi":"invoices.2024-07-30.product.live GET /invoices/render-settings","title":"Get or create Invoice Render Settings","href":"/reference/2024-07-30/invoices/get-or-create-invoice-render-settings"},{"openapi":"invoices.2024-07-30.product.live PUT /invoices/render-settings/{id}","title":"Update an Invoice Render Settings","href":"/reference/2024-07-30/invoices/update-an-invoice-render-settings"}]},{"group":"Credit Note Line Items","pages":[{"openapi":"invoices.2024-07-30.product.live PUT /credit-notes/{creditnote}/line-item-groups/{id}","title":"Update a Credit Note Line Item Group","href":"/reference/2024-07-30/invoices/update-a-credit-note-line-item-group"},{"openapi":"invoices.2024-07-30.product.live DELETE /credit-notes/{creditnote}/line-item-groups/{id}","title":"Delete a Credit Note Line Item Group","href":"/reference/2024-07-30/invoices/delete-a-credit-note-line-item-group"},{"openapi":"invoices.2024-07-30.product.live GET /credit-notes/{creditnote}/line-item-groups","title":"List all Credit Note Line Item Groups","href":"/reference/2024-07-30/invoices/list-all-credit-note-line-item-groups"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{creditnote}/line-item-groups","title":"Create a new Credit Note Line Item Group","href":"/reference/2024-07-30/invoices/create-a-new-credit-note-line-item-group"},{"openapi":"invoices.2024-07-30.product.live GET /credit-notes/{creditnote}/line-items","title":"List all Credit Note Line Items","href":"/reference/2024-07-30/invoices/list-all-credit-note-line-items"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{creditnote}/line-items","title":"Create a new Credit Note Line Item","href":"/reference/2024-07-30/invoices/create-a-new-credit-note-line-item"},{"openapi":"invoices.2024-07-30.product.live PUT /credit-notes/{creditnote}/line-items/{id}","title":"Update a Credit Note Line Item","href":"/reference/2024-07-30/invoices/update-a-credit-note-line-item"},{"openapi":"invoices.2024-07-30.product.live DELETE /credit-notes/{creditnote}/line-items/{id}","title":"Delete a Credit Note Line Item","href":"/reference/2024-07-30/invoices/delete-a-credit-note-line-item"}]}]},{"group":"Notifications","pages":[{"group":"Notification Policies","pages":[{"openapi":"notifications.2024-07-30.product.live POST /notifications/policies/{id}/recipients","title":"Add recipients to a policy","href":"/reference/2024-07-30/notifications/add-recipients-to-a-policy"},{"openapi":"notifications.2024-07-30.product.live POST /notifications/policies/{id}/notification-types","title":"Add notification types to a policy","href":"/reference/2024-07-30/notifications/add-notification-types-to-a-policy"},{"openapi":"notifications.2024-07-30.product.live DELETE /notifications/policies/{id}/notification-types/{type}","title":"Remove a notification type from a policy","href":"/reference/2024-07-30/notifications/remove-a-notification-type-from-a-policy"},{"openapi":"notifications.2024-07-30.product.live GET /notifications/policies","title":"List All Notification Policies","href":"/reference/2024-07-30/notifications/list-all-notification-policies"},{"openapi":"notifications.2024-07-30.product.live POST /notifications/policies","title":"Create Notification policy","href":"/reference/2024-07-30/notifications/create-notification-policy"},{"openapi":"notifications.2024-07-30.product.live GET /notifications/policies/{id}","title":"Get notification policy","href":"/reference/2024-07-30/notifications/get-notification-policy"},{"openapi":"notifications.2024-07-30.product.live DELETE /notifications/policies/{id}","title":"Delete notification policy","href":"/reference/2024-07-30/notifications/delete-notification-policy"},{"openapi":"notifications.2024-07-30.product.live DELETE /notifications/policies/{id}/recipients/{recipient}","title":"Remove a recipient from a policy","href":"/reference/2024-07-30/notifications/remove-a-recipient-from-a-policy"}]}]},{"group":"Orchestra","pages":[{"group":"Assets","pages":[{"openapi":"orchestra.2024-07-30.product.live POST /assets","title":"Upload an asset","href":"/reference/2024-07-30/orchestra/upload-an-asset"},{"openapi":"orchestra.2024-07-30.product.live GET /assets/{id}","title":"Get an asset","href":"/reference/2024-07-30/orchestra/get-an-asset"}]}]},{"group":"Product","pages":[{"group":"Products","pages":[{"openapi":"product.2024-07-30.product.live POST /products/{id}/archive","title":"Archive a product","href":"/reference/2024-07-30/product/archive-a-product"},{"openapi":"product.2024-07-30.product.live GET /products/{id}","title":"Get a Product by ID","href":"/reference/2024-07-30/product/get-a-product-by-id"},{"openapi":"product.2024-07-30.product.live PUT /products/{id}","title":"Update a Product","href":"/reference/2024-07-30/product/update-a-product"},{"openapi":"product.2024-07-30.product.live GET /products","title":"List all Products","href":"/reference/2024-07-30/product/list-all-products"},{"openapi":"product.2024-07-30.product.live POST /products","title":"Create a new Product","href":"/reference/2024-07-30/product/create-a-new-product"}]},{"group":"List Prices","pages":[{"openapi":"product.2024-07-30.product.live GET /list-prices/{id}","title":"Get a list price","href":"/reference/2024-07-30/product/get-a-list-price"},{"openapi":"product.2024-07-30.product.live PUT /list-prices/{id}","title":"Update a list price","href":"/reference/2024-07-30/product/update-a-list-price"},{"openapi":"product.2024-07-30.product.live POST /list-prices/{id}/archive","title":"Archive a list price","href":"/reference/2024-07-30/product/archive-a-list-price"},{"openapi":"product.2024-07-30.product.live GET /list-prices","title":"List all list prices","href":"/reference/2024-07-30/product/list-all-list-prices"},{"openapi":"product.2024-07-30.product.live POST /list-prices","title":"Create a list price","href":"/reference/2024-07-30/product/create-a-list-price"}]}]},{"group":"Quote","pages":[{"group":"Quotes","pages":[{"openapi":"quote.2024-07-30.product.live POST /quotes/{quoteId}/send-reminders","title":"Send reminder emails to all that have not signed.","href":"/reference/2024-07-30/quote/send-reminder-emails-to-all-that-have-not-signed."},{"openapi":"quote.2024-07-30.product.live GET /quotes/{id}","title":"Get one of your quotes","href":"/reference/2024-07-30/quote/get-one-of-your-quotes"},{"openapi":"quote.2024-07-30.product.live PUT /quotes/{id}","title":"Update one of your quotes","href":"/reference/2024-07-30/quote/update-one-of-your-quotes"},{"openapi":"quote.2024-07-30.product.live GET /quotes/{id}/analytics","title":"Get quote analytics","href":"/reference/2024-07-30/quote/get-quote-analytics"},{"openapi":"quote.2024-07-30.product.live POST /quotes/from-template/{id}","title":"Create a quote from a template","href":"/reference/2024-07-30/quote/create-a-quote-from-a-template"},{"openapi":"quote.2024-07-30.product.live POST /quotes/{id}/archive","title":"Archive a quote","href":"/reference/2024-07-30/quote/archive-a-quote"},{"openapi":"quote.2024-07-30.product.live GET /quotes/{id}/published","title":"Get a published quote","href":"/reference/2024-07-30/quote/get-a-published-quote"},{"openapi":"quote.2024-07-30.product.live GET /quotes","title":"List quotes","href":"/reference/2024-07-30/quote/list-quotes"},{"openapi":"quote.2024-07-30.product.live GET /quotes/{id}/download","title":"Download quote PDF","href":"/reference/2024-07-30/quote/download-quote-pdf"},{"openapi":"quote.2024-07-30.product.live POST /quotes/{quoteId}/notify-recipients","title":"Notify selected quote recipients by email","href":"/reference/2024-07-30/quote/notify-selected-quote-recipients-by-email"},{"openapi":"quote.2024-07-30.product.live POST /quotes/{id}/accept","title":"Accept a published Quote","href":"/reference/2024-07-30/quote/accept-a-published-quote"},{"openapi":"quote.2024-07-30.product.live POST /quotes/{id}/publish","title":"Publish a quote","href":"/reference/2024-07-30/quote/publish-a-quote"}]},{"group":"Quote Templates","pages":[{"openapi":"quote.2024-07-30.product.live GET /quote-templates","title":"List quote templates","href":"/reference/2024-07-30/quote/list-quote-templates"}]}]},{"group":"Taxes","pages":[{"group":"Tax Rates","pages":[{"openapi":"taxes.2024-07-30.product.live GET /tax-rates","title":"List all Tax Rates","href":"/reference/2024-07-30/taxes/list-all-tax-rates"},{"openapi":"taxes.2024-07-30.product.live POST /tax-rates","title":"Create a new TaxRate","href":"/reference/2024-07-30/taxes/create-a-new-taxrate"},{"openapi":"taxes.2024-07-30.product.live GET /tax-rates/{id}","title":"Get a Tax Rate by ID","href":"/reference/2024-07-30/taxes/get-a-tax-rate-by-id"},{"openapi":"taxes.2024-07-30.product.live PUT /tax-rates/{id}","title":"Update a TaxRate","href":"/reference/2024-07-30/taxes/update-a-taxrate"},{"openapi":"taxes.2024-07-30.product.live DELETE /tax-rates/{id}","title":"Delete a Tax Rate","href":"/reference/2024-07-30/taxes/delete-a-tax-rate"},{"openapi":"taxes.2024-07-30.product.live POST /tax-rates/{id}/archive","title":"Archive a tax rate","href":"/reference/2024-07-30/taxes/archive-a-tax-rate"}]},{"group":"Tax Registrations","pages":[{"openapi":"taxes.2024-07-30.product.live GET /tax-registrations","title":"List all Tax Registrations","href":"/reference/2024-07-30/taxes/list-all-tax-registrations"},{"openapi":"taxes.2024-07-30.product.live POST /tax-registrations","title":"Create a new Tax Registration","href":"/reference/2024-07-30/taxes/create-a-new-tax-registration"},{"openapi":"taxes.2024-07-30.product.live GET /tax-registrations/for-customer/{id}","title":"Get all tax registrations for a customer by customer ID","href":"/reference/2024-07-30/taxes/get-all-tax-registrations-for-a-customer-by-customer-id"},{"openapi":"taxes.2024-07-30.product.live GET /tax-registrations/for-merchant/{id}","title":"Get all tax registrations for a merchant by merchant ID","href":"/reference/2024-07-30/taxes/get-all-tax-registrations-for-a-merchant-by-merchant-id"},{"openapi":"taxes.2024-07-30.product.live GET /tax-registrations/{id}","title":"Get a Tax Registration by ID","href":"/reference/2024-07-30/taxes/get-a-tax-registration-by-id"},{"openapi":"taxes.2024-07-30.product.live PUT /tax-registrations/{id}","title":"Update a Tax Registration","href":"/reference/2024-07-30/taxes/update-a-tax-registration"},{"openapi":"taxes.2024-07-30.product.live DELETE /tax-registrations/{id}","title":"Delete a Tax Registration","href":"/reference/2024-07-30/taxes/delete-a-tax-registration"}]}]},{"group":"Usage","pages":[{"group":"Usage Events","pages":[{"openapi":"usage.2024-07-30.product.live GET /usage-events","title":"List all Usage Events","href":"/reference/2024-07-30/usage/list-all-usage-events"},{"openapi":"usage.2024-07-30.product.live POST /usage-events","title":"Create a new Usage Event","href":"/reference/2024-07-30/usage/create-a-new-usage-event"}]},{"group":"Seat Metrics","pages":[{"openapi":"usage.2024-07-30.product.live GET /seat-metrics","title":"List all seat metrics","href":"/reference/2024-07-30/usage/list-all-seat-metrics"},{"openapi":"usage.2024-07-30.product.live POST /seat-metrics","title":"Create a seat metric","href":"/reference/2024-07-30/usage/create-a-seat-metric"},{"openapi":"usage.2024-07-30.product.live GET /seat-metrics/{id}","title":"Get a seat metric","href":"/reference/2024-07-30/usage/get-a-seat-metric"},{"openapi":"usage.2024-07-30.product.live PUT /seat-metrics/{id}","title":"Update a seat metric","href":"/reference/2024-07-30/usage/update-a-seat-metric"},{"openapi":"usage.2024-07-30.product.live DELETE /seat-metrics/{id}","title":"Delete a seat metric","href":"/reference/2024-07-30/usage/delete-a-seat-metric"},{"openapi":"usage.2024-07-30.product.live GET /seat-balances","title":"List Seat balances by Customer","href":"/reference/2024-07-30/usage/list-seat-balances-by-customer"}]},{"group":"Seat Events","pages":[{"openapi":"usage.2024-07-30.product.live GET /seat-events","title":"List all seat events","href":"/reference/2024-07-30/usage/list-all-seat-events"},{"openapi":"usage.2024-07-30.product.live POST /seat-events","title":"Create a seat event","href":"/reference/2024-07-30/usage/create-a-seat-event"},{"openapi":"usage.2024-07-30.product.live GET /seat-events/{id}","title":"Get a seat event by ID","href":"/reference/2024-07-30/usage/get-a-seat-event-by-id"}]},{"group":"Usage Metrics","pages":[{"openapi":"usage.2024-07-30.product.live POST /usage-metrics","title":"Create a new Usage Metric","href":"/reference/2024-07-30/usage/create-a-new-usage-metric"},{"openapi":"usage.2024-07-30.product.live GET /usage-metrics","title":"List all Usage Metrics","href":"/reference/2024-07-30/usage/list-all-usage-metrics"},{"openapi":"usage.2024-07-30.product.live GET /usage-metrics/{id}","title":"Get a Usage Metric by ID","href":"/reference/2024-07-30/usage/get-a-usage-metric-by-id"},{"openapi":"usage.2024-07-30.product.live PUT /usage-metrics/{id}","title":"Update a Usage Metric","href":"/reference/2024-07-30/usage/update-a-usage-metric"},{"openapi":"usage.2024-07-30.product.live DELETE /usage-metrics/{id}","title":"Delete a Usage Metric","href":"/reference/2024-07-30/usage/delete-a-usage-metric"},{"openapi":"usage.2024-07-30.product.live GET /usage-metrics/{usageMetricId}/calculate","title":"Calculate usage metric for customer and timeframe","href":"/reference/2024-07-30/usage/calculate-usage-metric-for-customer-and-timeframe"}]}]}]}]},{"tab":"Connectors","pages":[{"title":"Connectors","href":"/connectors/overview"}]},{"tab":"Security","pages":[{"title":"Security","href":"/compliance/overview"}]},{"tab":"Compare","pages":[{"title":"Compare","href":"/migration/maxio"}]}]},"basePath":"","title":"List all Credit Notes - Sequence","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}