Get Invoice

Retrieve a specific invoice

curl --request GET \
  --url https://api.wellapp.ai/v1/invoices/{id} \
  --header 'Authorization: <authorization>'

{
  "data": {
    "type": "invoice",
    "id": "invoice_550e8400-e29b-41d4-a716-446655440000",
    "attributes": {
      "reference_number": "INV-2025-001",
      "document_type": "commercial_invoice",
      "document_type_code": "380",
      "issue_date": "2025-01-15",
      "due_date": "2025-02-15",
      "local_currency": "EUR",
      "local_totals": {
        "subtotal": "1000.00",
        "tax_total": "200.00",
        "total_amount": "1200.00"
      },
      "terms": "Payment due within 30 days",
      "billing_context": "subscription",
      "payment_status": {
        "paid": true,
        "amount_paid": 123,
        "amount_remaining": 123
      },
      "status": "draft",
      "description": "Professional services invoice for January 2025",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z"
    },
    "relationships": {
      "issuer": {
        "data": {
          "type": "company",
          "id": "company-issuer-uuid"
        }
      },
      "receiver": {
        "data": {
          "type": "company",
          "id": "company-receiver-uuid"
        }
      },
      "payment_means": {
        "data": [
          {
            "type": "payment_means",
            "id": "pm_1"
          }
        ]
      },
      "invoice_items": {
        "data": [
          {
            "type": "invoice_item",
            "id": "item_1"
          }
        ]
      },
      "documents": {
        "data": [
          {
            "type": "document",
            "id": "doc_original_invoice"
          }
        ]
      },
      "people": {
        "data": [
          {
            "type": "people",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "people",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "first_name": "John",
        "last_name": "Smith",
        "full_name": "John Smith",
        "email": "[email protected]",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    },
    {
      "type": "document",
      "id": "doc_original_invoice",
      "attributes": {
        "file_name": "invoice_2025_001.pdf",
        "status": "processed",
        "uploaded_at": "2023-11-07T05:31:56Z",
        "processed_at": "2023-11-07T05:31:56Z",
        "file_type": "application/pdf",
        "size_bytes": 245678,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    },
    {
      "type": "invoice_item",
      "id": "item_1",
      "attributes": {
        "line_id": "1",
        "sku": "WM-1001",
        "name": "Wireless Mouse",
        "description": "Ergonomic wireless mouse with USB receiver",
        "unit_price": 25,
        "currency": "EUR",
        "unit": "EA",
        "min_quantity": 1,
        "max_quantity": 500,
        "tax": {
          "rate": 20,
          "category": "standard",
          "scheme": "VAT"
        },
        "period": {
          "start": "2025-06-26",
          "end": "2025-06-27"
        },
        "created_at": "2025-05-11T13:42:12Z",
        "updated_at": "2025-05-11T13:45:20Z"
      }
    },
    {
      "type": "payment_means",
      "id": "pm_1",
      "attributes": {
        "type": "card_details",
        "scheme": "SEPA",
        "status": "active",
        "account_details": {
          "iban": "DE89370400440532013000",
          "bic": "COBADEFFXXX",
          "account_number": "532013000",
          "routing_number": "37040044",
          "currency": "EUR"
        },
        "bank_details": {
          "bank_name": "Commerzbank AG",
          "bank_code": "37040044",
          "branch_name": "Main Branch",
          "branch_code": "440"
        },
        "card_details": {
          "masked_pan": "****1234",
          "brand": "visa",
          "card_type": "credit",
          "expiry_month": 12,
          "expiry_year": 2027,
          "cardholder_name": "John Smith"
        },
        "digital_wallet": {
          "provider": "paypal",
          "wallet_id": "[email protected]",
          "wallet_type": "personal"
        },
        "compliance": {
          "kyc_status": "verified",
          "aml_status": "cleared",
          "sanctions_check": "passed",
          "last_compliance_check": "2023-11-07T05:31:56Z"
        },
        "metadata": {
          "source": "api",
          "external_id": "ext_pm_12345"
        },
        "nickname": "Primary Payment Method",
        "description": "Main company payment account",
        "tags": [
          "primary",
          "sepa"
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    },
    {
      "type": "company",
      "id": "company-receiver-uuid",
      "attributes": {
        "name": "ACME Corporation",
        "description": "Technology solutions provider",
        "domain_name_primary_link_url": "acme.com",
        "locale": "en",
        "tax_id": {
          "value": "DE123456789",
          "type": "VAT"
        },
        "registration": {
          "trade_name": "TechSol",
          "registered_name": "ACME Corporation GmbH"
        },
        "registration_number": {
          "business_type": "GmbH",
          "value": "HRB 123456",
          "registry_name": "Handelsregister Berlin",
          "registry_country": "DE"
        },
        "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    },
    {
      "type": "company",
      "id": "company-issuer-uuid",
      "attributes": {
        "name": "Service Provider Inc",
        "description": "Professional services company",
        "domain_name_primary_link_url": "serviceprovider.com",
        "locale": "en",
        "tax_id": {
          "value": "FR987654321",
          "type": "VAT"
        },
        "registration": {
          "trade_name": "Service Provider",
          "registered_name": "Service Provider Inc."
        },
        "registration_number": {
          "business_type": "Inc",
          "value": "RCS 987654",
          "registry_name": "Paris Commercial Registry",
          "registry_country": "FR"
        },
        "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

GET

invoices

{id}

Retrieve a specific invoice

curl --request GET \
  --url https://api.wellapp.ai/v1/invoices/{id} \
  --header 'Authorization: <authorization>'

{
  "data": {
    "type": "invoice",
    "id": "invoice_550e8400-e29b-41d4-a716-446655440000",
    "attributes": {
      "reference_number": "INV-2025-001",
      "document_type": "commercial_invoice",
      "document_type_code": "380",
      "issue_date": "2025-01-15",
      "due_date": "2025-02-15",
      "local_currency": "EUR",
      "local_totals": {
        "subtotal": "1000.00",
        "tax_total": "200.00",
        "total_amount": "1200.00"
      },
      "terms": "Payment due within 30 days",
      "billing_context": "subscription",
      "payment_status": {
        "paid": true,
        "amount_paid": 123,
        "amount_remaining": 123
      },
      "status": "draft",
      "description": "Professional services invoice for January 2025",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z"
    },
    "relationships": {
      "issuer": {
        "data": {
          "type": "company",
          "id": "company-issuer-uuid"
        }
      },
      "receiver": {
        "data": {
          "type": "company",
          "id": "company-receiver-uuid"
        }
      },
      "payment_means": {
        "data": [
          {
            "type": "payment_means",
            "id": "pm_1"
          }
        ]
      },
      "invoice_items": {
        "data": [
          {
            "type": "invoice_item",
            "id": "item_1"
          }
        ]
      },
      "documents": {
        "data": [
          {
            "type": "document",
            "id": "doc_original_invoice"
          }
        ]
      },
      "people": {
        "data": [
          {
            "type": "people",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "people",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "first_name": "John",
        "last_name": "Smith",
        "full_name": "John Smith",
        "email": "[email protected]",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    },
    {
      "type": "document",
      "id": "doc_original_invoice",
      "attributes": {
        "file_name": "invoice_2025_001.pdf",
        "status": "processed",
        "uploaded_at": "2023-11-07T05:31:56Z",
        "processed_at": "2023-11-07T05:31:56Z",
        "file_type": "application/pdf",
        "size_bytes": 245678,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    },
    {
      "type": "invoice_item",
      "id": "item_1",
      "attributes": {
        "line_id": "1",
        "sku": "WM-1001",
        "name": "Wireless Mouse",
        "description": "Ergonomic wireless mouse with USB receiver",
        "unit_price": 25,
        "currency": "EUR",
        "unit": "EA",
        "min_quantity": 1,
        "max_quantity": 500,
        "tax": {
          "rate": 20,
          "category": "standard",
          "scheme": "VAT"
        },
        "period": {
          "start": "2025-06-26",
          "end": "2025-06-27"
        },
        "created_at": "2025-05-11T13:42:12Z",
        "updated_at": "2025-05-11T13:45:20Z"
      }
    },
    {
      "type": "payment_means",
      "id": "pm_1",
      "attributes": {
        "type": "card_details",
        "scheme": "SEPA",
        "status": "active",
        "account_details": {
          "iban": "DE89370400440532013000",
          "bic": "COBADEFFXXX",
          "account_number": "532013000",
          "routing_number": "37040044",
          "currency": "EUR"
        },
        "bank_details": {
          "bank_name": "Commerzbank AG",
          "bank_code": "37040044",
          "branch_name": "Main Branch",
          "branch_code": "440"
        },
        "card_details": {
          "masked_pan": "****1234",
          "brand": "visa",
          "card_type": "credit",
          "expiry_month": 12,
          "expiry_year": 2027,
          "cardholder_name": "John Smith"
        },
        "digital_wallet": {
          "provider": "paypal",
          "wallet_id": "[email protected]",
          "wallet_type": "personal"
        },
        "compliance": {
          "kyc_status": "verified",
          "aml_status": "cleared",
          "sanctions_check": "passed",
          "last_compliance_check": "2023-11-07T05:31:56Z"
        },
        "metadata": {
          "source": "api",
          "external_id": "ext_pm_12345"
        },
        "nickname": "Primary Payment Method",
        "description": "Main company payment account",
        "tags": [
          "primary",
          "sepa"
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    },
    {
      "type": "company",
      "id": "company-receiver-uuid",
      "attributes": {
        "name": "ACME Corporation",
        "description": "Technology solutions provider",
        "domain_name_primary_link_url": "acme.com",
        "locale": "en",
        "tax_id": {
          "value": "DE123456789",
          "type": "VAT"
        },
        "registration": {
          "trade_name": "TechSol",
          "registered_name": "ACME Corporation GmbH"
        },
        "registration_number": {
          "business_type": "GmbH",
          "value": "HRB 123456",
          "registry_name": "Handelsregister Berlin",
          "registry_country": "DE"
        },
        "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    },
    {
      "type": "company",
      "id": "company-issuer-uuid",
      "attributes": {
        "name": "Service Provider Inc",
        "description": "Professional services company",
        "domain_name_primary_link_url": "serviceprovider.com",
        "locale": "en",
        "tax_id": {
          "value": "FR987654321",
          "type": "VAT"
        },
        "registration": {
          "trade_name": "Service Provider",
          "registered_name": "Service Provider Inc."
        },
        "registration_number": {
          "business_type": "Inc",
          "value": "RCS 987654",
          "registry_name": "Paris Commercial Registry",
          "registry_country": "FR"
        },
        "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Headers

Authorization

string

required

Bearer token for authentication

Path Parameters

string

required

Unique identifier of the invoice.

Query Parameters

include

string

Include related resources (e.g., documents)

Example:

"documents"

Response

Invoice retrieved successfully

data

object

Response schema for successfully created invoice

Show child attributes

data.data

object

Show child attributes

data.data.type

enum<string>

Resource type identifier

Available options:

invoice

data.data.id

string<uuid>

Unique identifier for the created invoice

Example:

"invoice_550e8400-e29b-41d4-a716-446655440000"

data.data.attributes

object

Show child attributes

data.data.attributes.reference_number

string

Unique reference number for the invoice

Example:

"INV-2025-001"

data.data.attributes.document_type

string

Type of invoice document

Example:

"commercial_invoice"

data.data.attributes.document_type_code

string

Standard document type code

Example:

"380"

data.data.attributes.issue_date

string<date>

Date when the invoice was issued

Example:

"2025-01-15"

data.data.attributes.due_date

string<date>

Payment due date

Example:

"2025-02-15"

data.data.attributes.local_currency

string

Currency code for the invoice

Example:

"EUR"

data.data.attributes.local_totals

object

Show child attributes

data.data.attributes.local_totals.subtotal

string

Subtotal before taxes and discounts

Example:

"1000.00"

data.data.attributes.local_totals.tax_total

string

Total tax amount

Example:

"200.00"

data.data.attributes.local_totals.total_amount

string

Final total amount

Example:

"1200.00"

data.data.attributes.terms

string

Contractual payment terms

data.data.attributes.billing_context

string

Billing context identifier

Example:

"subscription"

data.data.attributes.payment_status

object

Show child attributes

data.data.attributes.payment_status.paid

boolean

data.data.attributes.payment_status.amount_paid

number

data.data.attributes.payment_status.amount_remaining

number

data.data.attributes.status

enum<string>

Invoice lifecycle status

Available options:

draft,

sent,

viewed,

accepted,

rejected,

cancelled

Example:

"draft"

data.data.attributes.description

string

Invoice description or notes

Example:

"Professional services invoice for January 2025"

data.data.attributes.created_at

string<date-time>

Timestamp when the invoice was created

Example:

"2025-01-15T10:30:00Z"

data.data.attributes.updated_at

string<date-time>

Timestamp when the invoice was last updated

Example:

"2025-01-15T10:30:00Z"

data.data.relationships

object

Relationships with other resources

Show child attributes

data.data.relationships.issuer

object

Company issuing the invoice

Show child attributes

data.data.relationships.issuer.data

object

Show child attributes

data.data.relationships.issuer.data.type

string

Allowed value: "company"

data.data.relationships.issuer.data.id

string

uuid of company

Example:

"company-uuid"

data.data.relationships.receiver

object

Company receiving the invoice

Show child attributes

data.data.relationships.receiver.data

object

Show child attributes

data.data.relationships.receiver.data.type

string

Allowed value: "company"

data.data.relationships.receiver.data.id

string

uuid of company

Example:

"company-uuid"

data.data.relationships.payment_means

object

Associated payment methods

Show child attributes

data.data.relationships.payment_means.data

object[]

Show child attributes

data.data.relationships.payment_means.data.type

string

Allowed value: "payment_means"

data.data.relationships.payment_means.data.id

string

Example:

"pm_1"

data.data.relationships.invoice_items

object

Line items included in the invoice

Show child attributes

data.data.relationships.invoice_items.data

object[]

Show child attributes

data.data.relationships.invoice_items.data.type

string

Allowed value: "payment_means"

data.data.relationships.invoice_items.data.id

string

Example:

"pm_1"

data.data.relationships.documents

object

Supporting documents attached to the invoice

Show child attributes

data.data.relationships.documents.data

object[][]

Show child attributes

data.data.relationships.documents.data.type

string

Allowed value: "document"

data.data.relationships.documents.data.id

string

Example:

"doc_original_invoice"

data.data.relationships.people

object

Show child attributes

data.data.relationships.people.data

object[]

Show child attributes

data.data.relationships.people.data.type

string

required

Allowed value: "people"

data.data.relationships.people.data.id

string<uuid>

required

UUID of the person

data.data.relationships.people.data.attributes

object

Show child attributes

data.data.relationships.people.data.attributes.first_name

string

data.data.relationships.people.data.attributes.last_name

string

data.data.relationships.people.data.attributes.full_name

string

data.data.relationships.people.data.attributes.email

string<email>

data.data.relationships.people.data.attributes.created_at

string<date-time>

data.data.included

object

Show child attributes

data.data.included.documents

object

Correspondent/intermediary banks for routing (optional)

Show child attributes

data.data.included.documents.data

object

Show child attributes

data.data.included.documents.data.type

string

Allowed value: "company"

data.data.included.documents.data.id

string<uuid>

UUID of the parent company

data.data.included.documents.data.attributes

object

Show child attributes

data.data.included.documents.data.attributes.file_name

string

data.data.included.documents.data.attributes.status

string

data.data.included.documents.data.attributes.uploaded_at

string<date-time>

data.data.included.documents.data.attributes.processed_at

string<date-time>

data.data.included.documents.data.attributes.file_type

string

data.data.included.documents.data.attributes.size_bytes

integer

data.data.included.invoice_items

object

Correspondent/intermediary banks for routing (optional)

Show child attributes

data.data.included.invoice_items.data

object

Show child attributes

data.data.included.invoice_items.data.type

string

Allowed value: "company"

data.data.included.invoice_items.data.id

string<uuid>

UUID of the parent company

data.data.included.invoice_items.data.attributes

object

Show child attributes

data.data.included.invoice_items.data.attributes.line_id

string

Line identifier within the invoice

Example:

"1"

data.data.included.invoice_items.data.attributes.sku

string

Stock Keeping Unit identifier

Example:

"WM-1001"

data.data.included.invoice_items.data.attributes.name

string

Product or service name

Example:

"Wireless Mouse"

data.data.included.invoice_items.data.attributes.description

string

Detailed description of the item

Example:

"Ergonomic wireless mouse with USB receiver"

data.data.included.invoice_items.data.attributes.unit_price

number<decimal>

Unit price in local currency

Required range: x >= 0

Example:

25

data.data.included.invoice_items.data.attributes.currency

string

ISO 4217 currency code

Example:

"EUR"

data.data.included.invoice_items.data.attributes.unit

string

Unit of measurement

Example:

"EA"

data.data.included.invoice_items.data.attributes.min_quantity

integer

Minimum quantity allowed

Required range: x >= 0

Example:

1

data.data.included.invoice_items.data.attributes.max_quantity

integer

Maximum quantity allowed

Required range: x >= 1

Example:

500

data.data.included.invoice_items.data.attributes.tax

object

Show child attributes

data.data.included.invoice_items.data.attributes.tax.rate

number<decimal>

Tax rate as percentage

Required range: 0 <= x <= 100

Example:

20

data.data.included.invoice_items.data.attributes.tax.category

string

Tax category

Example:

"standard"

data.data.included.invoice_items.data.attributes.tax.scheme

string

Tax scheme identifier

Example:

"VAT"

data.data.included.invoice_items.data.attributes.period

object

Show child attributes

data.data.included.invoice_items.data.attributes.period.start

string<date>

Service period start date

Example:

"2025-06-26"

data.data.included.invoice_items.data.attributes.period.end

string<date>

Service period end date

Example:

"2025-06-27"

data.data.included.invoice_items.data.attributes.created_at

string<date-time>

Creation timestamp

Example:

"2025-05-11T13:42:12Z"

data.data.included.invoice_items.data.attributes.updated_at

string<date-time>

Last update timestamp

Example:

"2025-05-11T13:45:20Z"

data.data.included.payment_means

object

Correspondent/intermediary banks for routing (optional)

Show child attributes

data.data.included.payment_means.data

object

Show child attributes

data.data.included.payment_means.data.type

string

Allowed value: "company"

data.data.included.payment_means.data.id

string<uuid>

UUID of the parent company

data.data.included.payment_means.data.attributes

object

Show child attributes

data.data.included.payment_means.data.attributes.type

enum<string>

Type of payment means. See payment means types for details.

Available options:

card_details,

account_details,

wallet_details,

cash_details,

check_details,

crypto_details,

other

data.data.included.payment_means.data.attributes.scheme

enum<string>

Payment scheme or network. See scheme types for details.

Available options:

SEPA,

SWIFT,

ACH,

FASTER_PAYMENTS,

VISA,

MASTERCARD,

AMEX,

PAYPAL,

APPLEPAY,

GOOGLEPAY,

STRIPE,

LOCAL,

OTHER

data.data.included.payment_means.data.attributes.status

enum<string>

Current status of the payment means. See payment means status for details.

Available options:

active,

inactive,

pending_verification,

suspended,

expired,

blocked

data.data.included.payment_means.data.attributes.account_details

object

Bank account details for account_details type

Show child attributes

data.data.included.payment_means.data.attributes.account_details.iban

string

International Bank Account Number

data.data.included.payment_means.data.attributes.account_details.bic

string

Bank Identifier Code (SWIFT)

data.data.included.payment_means.data.attributes.account_details.account_number

string

Local account number (alternative to IBAN)

data.data.included.payment_means.data.attributes.account_details.routing_number

string

Bank routing number (US ACH)

data.data.included.payment_means.data.attributes.account_details.currency

string

Currency code (ISO 4217)

data.data.included.payment_means.data.attributes.bank_details

object

Additional bank information

Show child attributes

data.data.included.payment_means.data.attributes.bank_details.bank_name

string

Name of the bank

data.data.included.payment_means.data.attributes.bank_details.bank_code

string

Bank code or identifier

data.data.included.payment_means.data.attributes.bank_details.branch_name

string

Bank branch name

data.data.included.payment_means.data.attributes.bank_details.branch_code

string

Bank branch code

data.data.included.payment_means.data.attributes.card_details

object

Credit/debit card details for card_details type

Show child attributes

data.data.included.payment_means.data.attributes.card_details.masked_pan

string

Masked Primary Account Number (PCI DSS compliant)

data.data.included.payment_means.data.attributes.card_details.brand

enum<string>

Card brand

Available options:

visa,

mastercard,

amex,

discover,

diners,

jcb,

unionpay,

other

data.data.included.payment_means.data.attributes.card_details.card_type

enum<string>

Type of card

Available options:

credit,

debit,

prepaid,

charge

data.data.included.payment_means.data.attributes.card_details.expiry_month

integer

Card expiry month

data.data.included.payment_means.data.attributes.card_details.expiry_year

integer

Card expiry year

data.data.included.payment_means.data.attributes.card_details.cardholder_name

string

Name as printed on card

data.data.included.payment_means.data.attributes.digital_wallet

object

Digital wallet details for wallet_details type

Show child attributes

data.data.included.payment_means.data.attributes.digital_wallet.provider

enum<string>

Digital wallet provider

Available options:

paypal,

applepay,

googlepay,

stripe,

square,

venmo,

cashapp,

other

data.data.included.payment_means.data.attributes.digital_wallet.wallet_id

string

Wallet identifier (email, phone, etc.)

data.data.included.payment_means.data.attributes.digital_wallet.wallet_type

enum<string>

Type of wallet account

Available options:

personal,

business,

merchant

data.data.included.payment_means.data.attributes.compliance

object

Compliance and verification status

Show child attributes

data.data.included.payment_means.data.attributes.compliance.kyc_status

enum<string>

Know Your Customer verification status

Available options:

pending,

in_progress,

completed,

failed,

not_required

data.data.included.payment_means.data.attributes.compliance.aml_status

enum<string>

Anti-Money Laundering check status

Available options:

pending,

in_progress,

cleared,

flagged,

not_required

data.data.included.payment_means.data.attributes.compliance.sanctions_check

enum<string>

Sanctions screening status

Available options:

pending,

passed,

failed,

not_required

data.data.included.payment_means.data.attributes.compliance.last_compliance_check

string<date-time>

Last compliance check timestamp

data.data.included.payment_means.data.attributes.metadata

object

System metadata

Show child attributes

data.data.included.payment_means.data.attributes.metadata.source

enum<string>

How the payment means was created

Available options:

api,

dashboard,

import,

connector

data.data.included.payment_means.data.attributes.metadata.external_id

string

External system identifier

data.data.included.payment_means.data.attributes.nickname

string

User-friendly name for the payment means

data.data.included.payment_means.data.attributes.description

string

Additional description of the payment means

data.data.included.payment_means.data.attributes.tags

string[]

Tags for categorization

data.data.included.payment_means.data.attributes.created_at

string<date-time>

Creation timestamp

data.data.included.payment_means.data.attributes.updated_at

string<date-time>

Last update timestamp

data.data.included.receiver

object

Correspondent/intermediary banks for routing (optional)

Show child attributes

data.data.included.receiver.data

object

Show child attributes

data.data.included.receiver.data.type

string

Allowed value: "company"

data.data.included.receiver.data.id

string<uuid>

UUID of the parent company

data.data.included.receiver.data.attributes

object

Show child attributes

data.data.included.receiver.data.attributes.description

string

data.data.included.receiver.data.attributes.domain_name_primary_link_url

string<url>

The domain url from the website or email address of the company. Used as unique identifier in some cases.

Maximum string length: 500

data.data.included.receiver.data.attributes.tax_id

object

Show child attributes

data.data.included.receiver.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.data.included.receiver.data.attributes.tax_id.type

string

Type of tax ID, useful for applying formatting and validation rules.

data.data.included.receiver.data.attributes.registration

object

Show child attributes

data.data.included.receiver.data.attributes.registration.trade_name

string

Commercial or branding name (if different from registered name).

data.data.included.receiver.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.data.included.receiver.data.attributes.registration_number

object

Show child attributes

data.data.included.receiver.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.data.included.receiver.data.attributes.registration_number.value

string

Official company registration number.

data.data.included.receiver.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.data.included.receiver.data.attributes.registration_number.registry_country

string

Country of the registry authority. (string (ISO 3166-1 alpha-2))

data.data.included.receiver.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.data.included.receiver.data.attributes.created_at

string<date-time>

data.data.included.receiver.data.attributes.updated_at

string<date-time>

data.data.included.issuer

object

Correspondent/intermediary banks for routing (optional)

Show child attributes

data.data.included.issuer.data

object

Show child attributes

data.data.included.issuer.data.type

string

Allowed value: "company"

data.data.included.issuer.data.id

string<uuid>

UUID of the parent company

data.data.included.issuer.data.attributes

object

Show child attributes

data.data.included.issuer.data.attributes.description

string

data.data.included.issuer.data.attributes.domain_name_primary_link_url

string<url>

The domain url from the website or email address of the company. Used as unique identifier in some cases.

Maximum string length: 500

data.data.included.issuer.data.attributes.tax_id

object

Show child attributes

data.data.included.issuer.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.data.included.issuer.data.attributes.tax_id.type

string

Type of tax ID, useful for applying formatting and validation rules.

data.data.included.issuer.data.attributes.registration

object

Show child attributes

data.data.included.issuer.data.attributes.registration.trade_name

string

Commercial or branding name (if different from registered name).

data.data.included.issuer.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.data.included.issuer.data.attributes.registration_number

object

Show child attributes

data.data.included.issuer.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.data.included.issuer.data.attributes.registration_number.value

string

Official company registration number.

data.data.included.issuer.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.data.included.issuer.data.attributes.registration_number.registry_country

string

Country of the registry authority. (string (ISO 3166-1 alpha-2))

data.data.included.issuer.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.data.included.issuer.data.attributes.created_at

string<date-time>

data.data.included.issuer.data.attributes.updated_at

string<date-time>

Link Companies to Person Get Invoices

⌘I

Main Resources

Atomic Resources

System

Headers

Path Parameters

Query Parameters

Response