> ## Documentation Index > Fetch the complete documentation index at: https://docs.sequencehq.com/llms.txt > Use this file to discover all available pages before exploring further. # List all Credit Notes > List all Credit Notes for this Sequence account ## OpenAPI ````yaml invoices.latest.product.live GET /credit-notes openapi: 3.0.0 info: title: Invoices description: Create and issue invoices version: '0.1' servers: - url: https://dev.seqhq.io/api description: DEV - url: https://sandbox.sequencehq.com/api description: SANDBOX - url: https://eu.sequencehq.com/api description: PRODUCTION security: [] tags: [] paths: /credit-notes: servers: [] parameters: [] get: tags: - Credit Notes summary: List all Credit Notes description: List all Credit Notes for this Sequence account operationId: getCreditNotes parameters: - name: Authorization in: header description: >- Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`. required: true schema: type: string - 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 - 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 - 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 - name: sortOrder in: query description: >- Sort order. Default: DESC (descending, most often used for reverse chronological sorting). required: false schema: type: string - name: sortBy in: query description: >- Sort column. Default: creation time. Options: GROSS_TOTAL, CREDIT_NOTE_NUMBER, STATUS required: false schema: type: string - name: creditNoteStatus in: query description: >- Filter by credit note status. Options: DRAFT, FINAL, IN_PROGRESS, SENT, VOIDED required: false schema: type: string - name: customerId in: query description: Filter by customer id. required: false schema: type: string - name: sentBefore in: query description: 'Filter by sent date before. Format: yyyy-MM-dd' required: false schema: type: string - name: sentAfter in: query description: 'Filter by sent date after. Format: yyyy-MM-dd' required: false schema: type: string - name: searchCreditNoteNumber in: query description: >- Search credit notes by credit note number (partial, case-insensitive match) required: false schema: type: string - name: Sequence-Version in: header description: Use this header to select an API version required: false schema: type: string enum: - '2024-07-30' responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/ListCreditNoteEndpointProductListCreditNotePaginatedResponseModel example: items: - id: af60cab3-812d-4250-a051-0fb7133a00c7 sequenceAccountId: 68233908-402a-43b4-8952-1c2ab0ef0b25 status: DRAFT 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' applicationStatus: UNAPPLIED 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 examples: ListCreditNoteEndpointProductListCreditNotePaginatedResponseModel: summary: '' value: items: - id: af60cab3-812d-4250-a051-0fb7133a00c7 sequenceAccountId: 68233908-402a-43b4-8952-1c2ab0ef0b25 status: DRAFT 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' applicationStatus: UNAPPLIED 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 '400': description: Bad Request content: {} '401': description: Unauthorized content: {} '500': description: Internal Server Error content: {} components: schemas: ListCreditNoteEndpointProductListCreditNotePaginatedResponseModel: required: - items - pagination type: object example: items: - id: af60cab3-812d-4250-a051-0fb7133a00c7 sequenceAccountId: 68233908-402a-43b4-8952-1c2ab0ef0b25 status: DRAFT 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' applicationStatus: UNAPPLIED 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: DRAFT 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' applicationStatus: UNAPPLIED 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: $ref: '#/components/schemas/CreditNote' pagination: $ref: '#/components/schemas/PaginationResponse' CreditNote: required: - 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: DRAFT 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' applicationStatus: UNAPPLIED 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 sequenceAccountId: type: string description: Sequence Account ID example: 68233908-402a-43b4-8952-1c2ab0ef0b25 status: $ref: '#/components/schemas/CreditNoteStatus' description: Credit Note status invoiceId: type: string description: Invoice ID example: af60cab3-812d-4250-a051-0fb7133a00c7 invoiceNumber: type: string description: Invoice Number example: INV00001 billingScheduleId: type: string description: Subscription ID example: fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95 currency: $ref: '#/components/schemas/Currency' description: Credit Note currency issueDate: type: string description: Issue date format: date example: '2022-09-15' billingPeriodStart: type: string description: Billing period start example: '2022-10-01T00:00:00Z' billingPeriodEnd: type: string description: Billing period end example: '2022-10-30T00:00:00Z' creditNoteNumber: type: string description: Credit Note number example: CN00001 purchaseOrderNumber: type: string description: Purchase order number example: PO123 customerId: type: string description: The ID of the Customer this Credit Note is linked to example: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 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 customerLegalCompanyName: type: string description: Customer's legal company name example: Facebook customerBillingAddress: $ref: '#/components/schemas/Address' customerShippingAddress: $ref: '#/components/schemas/Address' memo: type: string description: Credit Note memo example: Thanks totalTax: type: string description: Total tax, in decimal format of the Credit Note's currency example: '2.50' netTotal: type: string description: Net total, in decimal format of the Credit Note's currency example: '51.20' grossTotal: type: string description: Gross total, in decimal format of the Invoice's currency example: '101.23' 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: $ref: '#/components/schemas/KeyValuePair' customerTaxId: type: string description: Customer's tax ID example: TAX123 linkedServices: type: array description: External services which are linked to this credit note example: - externalId: '123' externalService: Xero syncTime: '2022-06-28T16:47:00Z' items: $ref: '#/components/schemas/LinkInfo' applicationStatus: $ref: '#/components/schemas/CreditNoteApplicationStatus' description: >- Application status derived from the ledger account balance. Omitted for credit notes that are not in a terminal status merchantDetails: $ref: '#/components/schemas/InvoiceMerchantDetails' settings: $ref: '#/components/schemas/CreditNoteSettings' accountingDate: type: string description: Accounting date format: date example: '2022-09-30' PaginationResponse: type: object description: Results pagination example: after: >- ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw== before: >- NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND totalResultSize: 100 properties: after: type: string description: >- Copy this value to the `after` parameter of your next request to retrieve the next page of results example: >- ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw== before: type: string description: >- Copy this value to the `before` parameter of your next request to retrieve the next page of results example: >- NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND totalResultSize: type: integer description: Total number of entries across all pages format: int64 example: 100 CreditNoteStatus: type: string example: DRAFT enum: - DRAFT - FINAL - IN_PROGRESS - SENT - VOIDED 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 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: type: string description: Address line 2 example: 15 Yemen Road town: type: string description: Town or city example: Yemen state: $ref: '#/components/schemas/State' description: State or province (required for USA and Canada) postcode: type: string description: Postal code example: YE1 2YE country: $ref: '#/components/schemas/CountryCode' description: >- Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)) KeyValuePair: 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 LinkInfo: 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' externalService: $ref: '#/components/schemas/IntegrationService' description: The connected service syncTime: type: string description: The time that this was synced from the connected integration example: '2022-06-28T16:47:00Z' externalUrl: type: string description: External URL example: https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504 CreditNoteApplicationStatus: type: string example: UNAPPLIED enum: - UNAPPLIED - PARTIALLY_APPLIED - FULLY_APPLIED - UNKNOWN InvoiceMerchantDetails: 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: finance@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: The Merchant logoUrl: logo legalCompanyName: The Merchant primaryColour: '#000000' customFields: - key: example-label value: label-value includeBeneficiaryAddressInPaymentDetails: false properties: address: $ref: '#/components/schemas/Address' phoneNumber: type: string description: Merchant's phone number example: '0800001066' email: type: string description: Merchant's email example: finance@example.com taxId: type: string description: Merchant's tax ID example: TAX60 iban: type: string description: Merchant's IBAN, for receiving payment by bank transfer example: GB33BUKB20201555555555 ukAccountDetails: $ref: '#/components/schemas/SortCodeAccountNumber' usAchDetails: $ref: '#/components/schemas/UsAchDestination' usWireDetails: $ref: '#/components/schemas/UsWireDestination' caBankAccountDetails: $ref: '#/components/schemas/CanadianBankAccountDestination' canadianInternationalDestination: $ref: '#/components/schemas/CanadianInternationalDestination' australianDestination: $ref: '#/components/schemas/AustralianBankAccountDestination' swedishBankgiroDestination: $ref: '#/components/schemas/SwedishBankgiroDestination' logoUrl: type: string description: Merchant's logo image URL example: logo legalCompanyName: type: string description: Merchant's legal company name example: The Merchant primaryColour: type: string description: Merchant's primary colour (for invoice rendering) example: '#000000' customFields: type: array description: merchantCustomFields example: - key: example-label value: label-value items: $ref: '#/components/schemas/KeyValuePair' includeBeneficiaryAddressInPaymentDetails: type: boolean description: Include beneficiary address in payment details on invoice example: false CreditNoteSettings: required: - generateCashCreditGrant type: object description: Credit note settings example: generateCashCreditGrant: ENABLED properties: generateCashCreditGrant: $ref: '#/components/schemas/SettingPreference' description: >- Whether to generate a cash credit grant when sending this credit note State: 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 CountryCode: 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 IntegrationService: 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 SortCodeAccountNumber: 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' UsAchDestination: 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' UsWireDestination: 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: $ref: '#/components/schemas/Address' CanadianBankAccountDestination: 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' CanadianInternationalDestination: 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: $ref: '#/components/schemas/Address' institutionNumber: type: string example: '123' swiftCode: type: string example: CHASUS33 intermediaryBank: $ref: '#/components/schemas/IntermediaryBank' AustralianBankAccountDestination: 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' SwedishBankgiroDestination: required: - accountName - bankgiroNumber type: object description: >- Merchant's Swedish Bankgiro account details, for receiving payment by Swedish Bankgiro example: bankgiroNumber: 123-4567 accountName: The Merchant 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: The Merchant SettingPreference: type: string example: ENABLED enum: - ENABLED - DISABLED IntermediaryBank: 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: $ref: '#/components/schemas/Address' swiftCode: type: string example: CHASUS33 routingNumber: type: string example: '123456789' ````