e-invoice-api/src/resources/documents/documents.ts

The official TypeScript library for the e-invoice API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import * as DocumentsAPI from './documents';
import * as InboxAPI from '../inbox';
import * as AttachmentsAPI from './attachments';
import {
  AttachmentAddParams,
  AttachmentDeleteParams,
  AttachmentDeleteResponse,
  AttachmentListResponse,
  AttachmentRetrieveParams,
  Attachments,
  DocumentAttachment,
} from './attachments';
import * as UblAPI from './ubl';
import { Ubl, UblGetResponse } from './ubl';
import { APIPromise } from '../../core/api-promise';
import { DocumentsNumberPage } from '../../core/pagination';
import { RequestOptions } from '../../internal/request-options';
import { path } from '../../internal/utils/path';

export class Documents extends APIResource {
  attachments: AttachmentsAPI.Attachments = new AttachmentsAPI.Attachments(this._client);
  ubl: UblAPI.Ubl = new UblAPI.Ubl(this._client);

  /**
   * Create a new invoice or credit note
   */
  create(body: DocumentCreateParams, options?: RequestOptions): APIPromise<DocumentResponse> {
    return this._client.post('/api/documents/', { body, ...options });
  }

  /**
   * Get an invoice or credit note by ID
   */
  retrieve(documentID: string, options?: RequestOptions): APIPromise<DocumentResponse> {
    return this._client.get(path`/api/documents/${documentID}`, options);
  }

  /**
   * Delete an invoice or credit note
   */
  delete(documentID: string, options?: RequestOptions): APIPromise<DocumentDeleteResponse> {
    return this._client.delete(path`/api/documents/${documentID}`, options);
  }

  /**
   * Send an invoice or credit note via Peppol
   */
  send(
    documentID: string,
    params: DocumentSendParams | null | undefined = {},
    options?: RequestOptions,
  ): APIPromise<DocumentResponse> {
    const { email, receiver_peppol_id, receiver_peppol_scheme, sender_peppol_id, sender_peppol_scheme } =
      params ?? {};
    return this._client.post(path`/api/documents/${documentID}/send`, {
      query: { email, receiver_peppol_id, receiver_peppol_scheme, sender_peppol_id, sender_peppol_scheme },
      ...options,
    });
  }
}

export type DocumentResponsesDocumentsNumberPage = DocumentsNumberPage<DocumentResponse>;

export type CurrencyCode =
  | 'EUR'
  | 'USD'
  | 'GBP'
  | 'JPY'
  | 'CHF'
  | 'CAD'
  | 'AUD'
  | 'NZD'
  | 'CNY'
  | 'INR'
  | 'SEK'
  | 'NOK'
  | 'DKK'
  | 'SGD'
  | 'HKD';

export interface DocumentAttachmentCreate {
  file_name: string;

  /**
   * Base64 encoded file data
   */
  file_data?: string | null;

  file_size?: number;

  file_type?: string;
}

export interface DocumentCreate {
  amount_due?: number | string | null;

  attachments?: Array<DocumentAttachmentCreate> | null;

  billing_address?: string | null;

  billing_address_recipient?: string | null;

  /**
   * Currency of the invoice
   */
  currency?: CurrencyCode;

  customer_address?: string | null;

  customer_address_recipient?: string | null;

  customer_email?: string | null;

  customer_id?: string | null;

  customer_name?: string | null;

  customer_tax_id?: string | null;

  direction?: DocumentDirection;

  document_type?: DocumentType;

  due_date?: string | null;

  invoice_date?: string | null;

  invoice_id?: string | null;

  invoice_total?: number | string | null;

  items?: Array<DocumentCreate.Item> | null;

  note?: string | null;

  payment_details?: Array<PaymentDetailCreate> | null;

  payment_term?: string | null;

  previous_unpaid_balance?: number | string | null;

  purchase_order?: string | null;

  remittance_address?: string | null;

  remittance_address_recipient?: string | null;

  service_address?: string | null;

  service_address_recipient?: string | null;

  service_end_date?: string | null;

  service_start_date?: string | null;

  shipping_address?: string | null;

  shipping_address_recipient?: string | null;

  state?: InboxAPI.DocumentState;

  subtotal?: number | string | null;

  tax_details?: Array<DocumentCreate.TaxDetail> | null;

  total_discount?: number | string | null;

  total_tax?: number | string | null;

  vendor_address?: string | null;

  vendor_address_recipient?: string | null;

  vendor_email?: string | null;

  vendor_name?: string | null;

  vendor_tax_id?: string | null;
}

export namespace DocumentCreate {
  export interface Item {
    amount?: number | string | null;

    date?: null;

    description?: string | null;

    product_code?: string | null;

    quantity?: number | string | null;

    tax?: number | string | null;

    tax_rate?: string | null;

    /**
     * Unit of Measure Codes from UNECERec20 used in Peppol BIS Billing 3.0.
     */
    unit?: DocumentsAPI.UnitOfMeasureCode | null;

    unit_price?: number | string | null;
  }

  export interface TaxDetail {
    amount?: number | string | null;

    rate?: string | null;
  }
}

export type DocumentDirection = 'INBOUND' | 'OUTBOUND';

export interface DocumentResponse {
  id: string;

  amount_due?: string | null;

  attachments?: Array<AttachmentsAPI.DocumentAttachment>;

  billing_address?: string | null;

  billing_address_recipient?: string | null;

  /**
   * Currency of the invoice
   */
  currency?: CurrencyCode;

  customer_address?: string | null;

  customer_address_recipient?: string | null;

  customer_email?: string | null;

  customer_id?: string | null;

  customer_name?: string | null;

  customer_tax_id?: string | null;

  direction?: DocumentDirection;

  document_type?: DocumentType;

  due_date?: string | null;

  invoice_date?: string | null;

  invoice_id?: string | null;

  invoice_total?: string | null;

  items?: Array<DocumentResponse.Item>;

  note?: string | null;

  payment_details?: Array<DocumentResponse.PaymentDetail>;

  payment_term?: string | null;

  previous_unpaid_balance?: string | null;

  purchase_order?: string | null;

  remittance_address?: string | null;

  remittance_address_recipient?: string | null;

  service_address?: string | null;

  service_address_recipient?: string | null;

  service_end_date?: string | null;

  service_start_date?: string | null;

  shipping_address?: string | null;

  shipping_address_recipient?: string | null;

  state?: InboxAPI.DocumentState;

  subtotal?: string | null;

  tax_details?: Array<DocumentResponse.TaxDetail>;

  total_discount?: string | null;

  total_tax?: string | null;

  vendor_address?: string | null;

  vendor_address_recipient?: string | null;

  vendor_email?: string | null;

  vendor_name?: string | null;

  vendor_tax_id?: string | null;
}

export namespace DocumentResponse {
  export interface Item {
    amount?: string | null;

    date?: null;

    description?: string | null;

    product_code?: string | null;

    quantity?: string | null;

    tax?: string | null;

    tax_rate?: string | null;

    /**
     * Unit of Measure Codes from UNECERec20 used in Peppol BIS Billing 3.0.
     */
    unit?: DocumentsAPI.UnitOfMeasureCode | null;

    unit_price?: string | null;
  }

  export interface PaymentDetail {
    bank_account_number?: string | null;

    iban?: string | null;

    payment_reference?: string | null;

    swift?: string | null;
  }

  export interface TaxDetail {
    amount?: string | null;

    rate?: string | null;
  }
}

export type DocumentType = 'INVOICE' | 'CREDIT_NOTE' | 'DEBIT_NOTE';

export interface PaymentDetailCreate {
  bank_account_number?: string | null;

  iban?: string | null;

  payment_reference?: string | null;

  swift?: string | null;
}

/**
 * Unit of Measure Codes from UNECERec20 used in Peppol BIS Billing 3.0.
 */
export type UnitOfMeasureCode =
  | '10'
  | '11'
  | '13'
  | '14'
  | '15'
  | '20'
  | '21'
  | '22'
  | '23'
  | '24'
  | '25'
  | '27'
  | '28'
  | '33'
  | '34'
  | '35'
  | '37'
  | '38'
  | '40'
  | '41'
  | '56'
  | '57'
  | '58'
  | '59'
  | '60'
  | '61'
  | '74'
  | '77'
  | '80'
  | '81'
  | '85'
  | '87'
  | '89'
  | '91'
  | '1I'
  | 'EA'
  | 'E01'
  | 'E07'
  | 'E09'
  | 'E10'
  | 'E12'
  | 'E14'
  | 'E17'
  | 'E20'
  | 'E23'
  | 'E25'
  | 'E27'
  | 'E31'
  | 'E34'
  | 'E35'
  | 'E36'
  | 'E37'
  | 'E38'
  | 'E39'
  | 'E40'
  | 'E41'
  | 'E42'
  | 'E43'
  | 'E44'
  | 'E45'
  | 'E46'
  | 'E47'
  | 'E48'
  | 'E49'
  | 'E50'
  | 'E51'
  | 'E52'
  | 'E53'
  | 'E54'
  | 'E55'
  | 'E56'
  | 'E57'
  | 'E58'
  | 'E60'
  | 'E62'
  | 'E65'
  | 'E66'
  | 'E67'
  | 'E69'
  | 'E70'
  | 'E71'
  | 'E73'
  | 'E75'
  | 'E76'
  | '2A'
  | '2B'
  | '2C'
  | '2G'
  | '2H'
  | '2I'
  | '2J'
  | '2K'
  | '2L'
  | '2M'
  | '2N'
  | '2P'
  | '2Q'
  | '2R'
  | '2U'
  | '2X'
  | '2Y'
  | '2Z'
  | '3B'
  | '3C'
  | '4C'
  | '4G'
  | '4H'
  | '4K'
  | '4L'
  | '4M'
  | '4N'
  | '4O'
  | '4P'
  | '4Q'
  | '4R'
  | '4T'
  | '4U'
  | '4W'
  | '4X'
  | '5A'
  | '5B'
  | '5E'
  | '5J'
  | 'A10'
  | 'A11'
  | 'A12'
  | 'A13'
  | 'A14'
  | 'A15'
  | 'A16'
  | 'A17'
  | 'A18'
  | 'A19'
  | 'A2'
  | 'A20'
  | 'A21'
  | 'A22'
  | 'A23'
  | 'A24'
  | 'A26'
  | 'A27'
  | 'A28'
  | 'A29'
  | 'A3'
  | 'A30'
  | 'A31'
  | 'A32'
  | 'A33'
  | 'A34'
  | 'A35'
  | 'A36'
  | 'A37'
  | 'A38'
  | 'A39'
  | 'A4'
  | 'A40'
  | 'A41'
  | 'A42'
  | 'A43'
  | 'A44'
  | 'A45'
  | 'A46'
  | 'A47'
  | 'A48'
  | 'A49'
  | 'A5'
  | 'A50'
  | 'A51'
  | 'A52'
  | 'A53'
  | 'A54'
  | 'A55'
  | 'A56'
  | 'A57'
  | 'A58'
  | 'A59'
  | 'A6'
  | 'A60'
  | 'A61'
  | 'A62'
  | 'A63'
  | 'A64'
  | 'A65'
  | 'A66'
  | 'A67'
  | 'A68'
  | 'A69'
  | 'A7'
  | 'A70'
  | 'A71'
  | 'A72'
  | 'A73'
  | 'A74'
  | 'A75'
  | 'A76'
  | 'A77'
  | 'A78'
  | 'A79'
  | 'A8'
  | 'A80'
  | 'A81'
  | 'A82'
  | 'A83'
  | 'A84'
  | 'A85'
  | 'A86'
  | 'A87'
  | 'A88'
  | 'A89'
  | 'A9'
  | 'A90'
  | 'A91'
  | 'A92'
  | 'A93'
  | 'A94'
  | 'A95'
  | 'A96'
  | 'A97'
  | 'A98'
  | 'A99'
  | 'ACR'
  | 'AH'
  | 'AI'
  | 'AK'
  | 'AMH'
  | 'AMT'
  | 'ANN'
  | 'B1'
  | 'B11'
  | 'B12'
  | 'B13'
  | 'B14'
  | 'B15'
  | 'B16'
  | 'B17'
  | 'B18'
  | 'B19'
  | 'B20'
  | 'B21'
  | 'B22'
  | 'B23'
  | 'B24'
  | 'B25'
  | 'B26'
  | 'B27'
  | 'B28'
  | 'B29'
  | 'B3'
  | 'B30'
  | 'B31'
  | 'B32'
  | 'B33'
  | 'B34'
  | 'B35'
  | 'B36'
  | 'B37'
  | 'B38'
  | 'B39'
  | 'B4'
  | 'B40'
  | 'B41'
  | 'B42'
  | 'B43'
  | 'B44'
  | 'B45'
  | 'B46'
  | 'B47'
  | 'B48'
  | 'B49'
  | 'B5'
  | 'B50'
  | 'B52'
  | 'B53'
  | 'B54'
  | 'B55'
  | 'B56'
  | 'B57'
  | 'B58'
  | 'B59'
  | 'B6'
  | 'B60'
  | 'B61'
  | 'B62'
  | 'B63'
  | 'B64'
  | 'B65'
  | 'B66'
  | 'B67'
  | 'B68'
  | 'B69'
  | 'B7'
  | 'B70'
  | 'B71'
  | 'B72'
  | 'B73'
  | 'B74'
  | 'B75'
  | 'B76'
  | 'B77'
  | 'B78'
  | 'B79'
  | 'B8'
  | 'B80'
  | 'B81'
  | 'B82'
  | 'B83'
  | 'B84'
  | 'B85'
  | 'B86'
  | 'B87'
  | 'B88'
  | 'B89'
  | 'B9'
  | 'B90'
  | 'B91'
  | 'B92'
  | 'B93'
  | 'B94'
  | 'B95'
  | 'B96'
  | 'B97'
  | 'B98'
  | 'B99'
  | 'BAR'
  | 'BB'
  | 'BFT'
  | 'BHP'
  | 'BIL'
  | 'BLD'
  | 'BLL'
  | 'BUA'
  | 'BUI'
  | 'C0'
  | 'C10'
  | 'C11'
  | 'C12'
  | 'C13'
  | 'C14'
  | 'C15'
  | 'C16'
  | 'C17'
  | 'C18'
  | 'C19'
  | 'C20'
  | 'C21'
  | 'C22'
  | 'C23'
  | 'C24'
  | 'C25'
  | 'C26'
  | 'C27'
  | 'C28'
  | 'C29'
  | 'C30'
  | 'C31'
  | 'C32'
  | 'C33'
  | 'C34'
  | 'C35'
  | 'C36'
  | 'C37'
  | 'C38'
  | 'C39'
  | 'C40'
  | 'C41'
  | 'C42'
  | 'C43'
  | 'C44'
  | 'C45'
  | 'C46'
  | 'C47'
  | 'C48'
  | 'C49'
  | 'C50'
  | 'C51'
  | 'C52'
  | 'C53'
  | 'C54'
  | 'C55'
  | 'C56'
  | 'C57'
  | 'C58'
  | 'C59'
  | 'C60'
  | 'C61'
  | 'C62'
  | 'C63'
  | 'C64'
  | 'C65'
  | 'C66'
  | 'C67'
  | 'C68'
  | 'C69'
  | 'C70'
  | 'C71'
  | 'C72'
  | 'C73'
  | 'C74'
  | 'C75'
  | 'C76'
  | 'C77'
  | 'C78'
  | 'C79'
  | 'C80'
  | 'C81'
  | 'C82'
  | 'C83'
  | 'C84'
  | 'C85'
  | 'C86'
  | 'C87'
  | 'C88'
  | 'C89'
  | 'C90'
  | 'C91'
  | 'C92'
  | 'C93'
  | 'C94'
  | 'C95'
  | 'C96'
  | 'C97'
  | 'C98'
  | 'C99'
  | 'CDL'
  | 'CEL'
  | 'CHU'
  | 'CIU'
  | 'CLT'
  | 'CMK'
  | 'CMQ'
  | 'CMT'
  | 'CNP'
  | 'CNT'
  | 'COU'
  | 'CTG'
  | 'CTN'
  | 'CUR'
  | 'CWA'
  | 'CWI'
  | 'DAN'
  | 'DAY'
  | 'DB'
  | 'DD'
  | 'DG'
  | 'DI'
  | 'DLT'
  | 'DMK'
  | 'DMQ'
  | 'DMT'
  | 'DPC'
  | 'DPT'
  | 'DRA'
  | 'DZN'
  | 'DZP'
  | 'FOT'
  | 'GLL'
  | 'GLI'
  | 'GRM'
  | 'GRO'
  | 'HUR'
  | 'HTZ'
  | 'INH'
  | 'KGM'
  | 'KMT'
  | 'MTR'
  | 'SMI'
  | 'MIN'
  | 'MON'
  | 'ONZ'
  | 'PCE'
  | 'LBR'
  | 'QT'
  | 'SEC'
  | 'FTK'
  | 'INK'
  | 'MTK'
  | 'YDK'
  | 'TNE'
  | 'VLT'
  | 'WTT'
  | 'YRD'
  | 'FTQ'
  | 'INQ'
  | 'MTQ'
  | 'YDQ'
  | 'HAR'
  | 'KLT'
  | 'MLT'
  | 'MMT'
  | 'KMK'
  | 'MMK'
  | 'XAA'
  | 'XAB'
  | 'XAC'
  | 'XAD'
  | 'XAE'
  | 'XAF'
  | 'XAG'
  | 'XAH'
  | 'XAI'
  | 'XAJ'
  | 'XAL'
  | 'XAM'
  | 'XAP'
  | 'XAT'
  | 'XAV'
  | 'XB4'
  | 'XBA'
  | 'XBB'
  | 'XBC'
  | 'XBD'
  | 'XBE'
  | 'XBF'
  | 'XBG'
  | 'XBH'
  | 'XBI'
  | 'XBJ'
  | 'XBK'
  | 'XBL'
  | 'XBM'
  | 'XBN'
  | 'XBO'
  | 'XBP'
  | 'XBQ'
  | 'XBR'
  | 'XBS'
  | 'XBT'
  | 'XBU'
  | 'XBV'
  | 'XBW'
  | 'XBX'
  | 'XBY'
  | 'XBZ'
  | 'XCA'
  | 'XCB'
  | 'XCC'
  | 'XCD'
  | 'XCE'
  | 'XCF'
  | 'XCG'
  | 'XCH'
  | 'XCI'
  | 'XCJ'
  | 'XCK'
  | 'XCL'
  | 'XCM'
  | 'XCN'
  | 'XCO'
  | 'XCP'
  | 'XCQ'
  | 'XCR'
  | 'XCS'
  | 'XCT'
  | 'XCU'
  | 'XCV'
  | 'XCW'
  | 'XCX'
  | 'XCY'
  | 'XCZ'
  | 'XDA'
  | 'XDB'
  | 'XDC'
  | 'XDD'
  | 'XDE'
  | 'XDF'
  | 'XDG'
  | 'XDH'
  | 'XDI'
  | 'XDJ'
  | 'XDK'
  | 'XDL'
  | 'XDM'
  | 'XDN'
  | 'XDP'
  | 'XDQ'
  | 'XDR'
  | 'XDS'
  | 'XDT'
  | 'XDU'
  | 'XDV'
  | 'XDW'
  | 'XDX'
  | 'XDY'
  | 'XDZ'
  | 'XEA'
  | 'XEB'
  | 'XEC'
  | 'XED'
  | 'XEE'
  | 'XEF'
  | 'XEG'
  | 'XEH'
  | 'XEI'
  | 'XEJ'
  | 'XEK'
  | 'XEL'
  | 'XEM'
  | 'XEN'
  | 'XEP'
  | 'XEQ'
  | 'XER'
  | 'XES'
  | 'XET'
  | 'XEU'
  | 'XEV'
  | 'XEW'
  | 'XEX'
  | 'XEY'
  | 'XFB'
  | 'XFC'
  | 'XFD'
  | 'XFE'
  | 'XFF'
  | 'XFG'
  | 'XFH'
  | 'XFI'
  | 'XFJ'
  | 'XFK'
  | 'XFL'
  | 'XFM'
  | 'XFN'
  | 'XFO'
  | 'XFP'
  | 'XFQ'
  | 'XFR'
  | 'XFS'
  | 'XFT'
  | 'XFU'
  | 'XFV'
  | 'XFW'
  | 'XFX'
  | 'XFY'
  | 'XFZ'
  | 'XGA'
  | 'XGB'
  | 'XGC'
  | 'XGD'
  | 'XGE'
  | 'XGF'
  | 'XGG'
  | 'XGH'
  | 'XGI'
  | 'XGJ'
  | 'XGK'
  | 'XGL'
  | 'XGM'
  | 'XGN'
  | 'XGO'
  | 'XGP'
  | 'XGQ'
  | 'XGR'
  | 'XGS'
  | 'XGT'
  | 'XGU'
  | 'XGV'
  | 'XGW'
  | 'XGX'
  | 'XGY'
  | 'XGZ'
  | 'XHA'
  | 'XHB'
  | 'XHC'
  | 'XHD'
  | 'XHE'
  | 'XHF'
  | 'XHG'
  | 'XHH'
  | 'XHI'
  | 'XHJ'
  | 'XHK'
  | 'XHL'
  | 'XHM'
  | 'XHN'
  | 'XHP'
  | 'XHQ'
  | 'XHR'
  | 'XHS'
  | 'XHT'
  | 'XHU'
  | 'XHV'
  | 'XHW'
  | 'XHX'
  | 'XHY'
  | 'XHZ'
  | 'XIA'
  | 'XIB'
  | 'XIC'
  | 'XID'
  | 'XIE'
  | 'XIF'
  | 'XIG'
  | 'XIH'
  | 'XII'
  | 'XIJ'
  | 'XIK'
  | 'XIL'
  | 'XIM'
  | 'XIN'
  | 'XIO'
  | 'XJA'
  | 'XJB'
  | 'XJC'
  | 'XJD'
  | 'XJE'
  | 'XJF'
  | 'XJG'
  | 'XJH'
  | 'XJI'
  | 'XJJ'
  | 'XJK'
  | 'XJL'
  | 'XJM'
  | 'XJN'
  | 'XJO'
  | 'XJP'
  | 'XJQ'
  | 'XJR'
  | 'XJS'
  | 'XJT'
  | 'XJU'
  | 'XJV'
  | 'XJW'
  | 'XJX'
  | 'XJY'
  | 'XJZ'
  | 'XLA'
  | 'XLB'
  | 'XLC'
  | 'XLD'
  | 'XLE'
  | 'XLF'
  | 'XLG'
  | 'XLH'
  | 'XLI'
  | 'XLJ'
  | 'XLK'
  | 'XLL'
  | 'XLM'
  | 'XLN'
  | 'XLO'
  | 'XLP'
  | 'XLQ'
  | 'XLR'
  | 'XLS'
  | 'XLT'
  | 'XLU'
  | 'XLV'
  | 'XLW'
  | 'XLX'
  | 'XLY'
  | 'XLZ'
  | 'XMA'
  | 'XMB'
  | 'XMC'
  | 'XMD'
  | 'XME'
  | 'XMF'
  | 'XMG'
  | 'XMH'
  | 'XMI'
  | 'XMJ'
  | 'XMK'
  | 'XML'
  | 'XMM'
  | 'XMN'
  | 'XMO'
  | 'XMP'
  | 'XMQ'
  | 'XMR'
  | 'XMS'
  | 'XMT'
  | 'XMU'
  | 'XMV'
  | 'XMW'
  | 'XMX'
  | 'XMY'
  | 'XMZ'
  | 'XNA'
  | 'XNB'
  | 'XNC'
  | 'XND'
  | 'XNE'
  | 'XNF'
  | 'XNG'
  | 'XNH'
  | 'XNI'
  | 'XNJ'
  | 'XNK'
  | 'XNL'
  | 'XNM'
  | 'XOA'
  | 'XOB'
  | 'XOC'
  | 'XOD'
  | 'XOE'
  | 'XOF'
  | 'XOG'
  | 'XOH'
  | 'XOI'
  | 'XOJ'
  | 'XOK'
  | 'XOL'
  | 'XOM'
  | 'XON'
  | 'XOO'
  | 'XOP'
  | 'XOQ'
  | 'XOR'
  | 'XOS'
  | 'XOT'
  | 'XOU'
  | 'XOV'
  | 'XOW'
  | 'XOX'
  | 'XOY'
  | 'XOZ'
  | 'XP1'
  | 'XP2'
  | 'XP3'
  | 'XP4'
  | 'XPA'
  | 'XPB'
  | 'XPC'
  | 'XPD'
  | 'XPE'
  | 'XPF'
  | 'XPG'
  | 'XPH'
  | 'XPI'
  | 'XPJ'
  | 'XPK'
  | 'XPL'
  | 'XPM'
  | 'XPN'
  | 'XPO'
  | 'XPP'
  | 'XPQ'
  | 'XPR'
  | 'XPS'
  | 'XPT'
  | 'XPU'
  | 'XPV'
  | 'XPW'
  | 'XPX'
  | 'XPY'
  | 'XPZ'
  | 'XQA'
  | 'XQB'
  | 'XQC'
  | 'XQD'
  | 'XQE'
  | 'XQF'
  | 'XQG'
  | 'XQH'
  | 'XQI'
  | 'XQJ'
  | 'XQK'
  | 'XQL'
  | 'XQM'
  | 'XQN'
  | 'XQO'
  | 'XQP'
  | 'XQQ'
  | 'XQR'
  | 'XQS'
  | 'XRD'
  | 'XRE'
  | 'XRF'
  | 'XRG'
  | 'XRH'
  | 'XRI'
  | 'XRJ'
  | 'XRK'
  | 'XRL'
  | 'XRM'
  | 'XRN'
  | 'XRO'
  | 'XRP'
  | 'XRQ'
  | 'XRR'
  | 'XRS'
  | 'XRT'
  | 'XRU'
  | 'XRV'
  | 'XRW'
  | 'XRX'
  | 'XRY'
  | 'XRZ'
  | 'XSA'
  | 'XSB'
  | 'XSC'
  | 'XSD'
  | 'XSE'
  | 'XSF'
  | 'XSG'
  | 'XSH'
  | 'XSI'
  | 'XSJ'
  | 'XSK'
  | 'XSL'
  | 'XSM'
  | 'XSN'
  | 'XSO'
  | 'XSP'
  | 'XSQ'
  | 'XSR'
  | 'XSS'
  | 'XST'
  | 'XSU'
  | 'XSV'
  | 'XSW'
  | 'XSX'
  | 'XSY'
  | 'XSZ'
  | 'XTA'
  | 'XTB'
  | 'XTC'
  | 'XTD'
  | 'XTE'
  | 'XTF'
  | 'XTG'
  | 'XTI'
  | 'XTJ'
  | 'XTK'
  | 'XTL'
  | 'XTM'
  | 'XTN'
  | 'XTO'
  | 'XTR'
  | 'XTS'
  | 'XTT'
  | 'XTU'
  | 'XTV'
  | 'XTW'
  | 'XTX'
  | 'XTY'
  | 'XTZ'
  | 'XUC'
  | 'XUN'
  | 'XVA'
  | 'XVG'
  | 'XVI'
  | 'XVK'
  | 'XVL'
  | 'XVN'
  | 'XVO'
  | 'XVP'
  | 'XVQ'
  | 'XVR'
  | 'XVS'
  | 'XVY'
  | 'XWA'
  | 'XWB'
  | 'XWC'
  | 'XWD'
  | 'XWF'
  | 'XWG'
  | 'XWH'
  | 'XWJ'
  | 'XWK'
  | 'XWL'
  | 'XWM'
  | 'XWN'
  | 'XWP'
  | 'XWQ'
  | 'XWR'
  | 'XWS'
  | 'XWT'
  | 'XWU'
  | 'XWV'
  | 'XWW'
  | 'XWX'
  | 'XWY'
  | 'XWZ'
  | 'XXA'
  | 'XXB'
  | 'XXC'
  | 'XXD'
  | 'XXF'
  | 'XXG'
  | 'XXH'
  | 'XXJ'
  | 'XXK'
  | 'XYA'
  | 'XYB'
  | 'XYC'
  | 'XYD'
  | 'XYF'
  | 'XYG'
  | 'XYH'
  | 'XYJ'
  | 'XYK'
  | 'XYL'
  | 'XYM'
  | 'XYN'
  | 'XYP'
  | 'XYQ'
  | 'XYR'
  | 'XYS'
  | 'XYT'
  | 'XYV'
  | 'XYW'
  | 'XYX'
  | 'XYY'
  | 'XYZ'
  | 'XZA'
  | 'XZB'
  | 'XZC'
  | 'XZD'
  | 'XZF'
  | 'XZG'
  | 'XZH'
  | 'XZJ'
  | 'XZK'
  | 'XZL'
  | 'XZM'
  | 'XZN'
  | 'XZP'
  | 'XZQ'
  | 'XZR'
  | 'XZS'
  | 'XZT'
  | 'XZU'
  | 'XZV'
  | 'XZW'
  | 'XZX'
  | 'XZY'
  | 'XZZ'
  | 'ZZ'
  | 'NAR'
  | 'LTR';

export interface DocumentDeleteResponse {
  is_deleted: boolean;
}

export interface DocumentCreateParams {
  amount_due?: number | string | null;

  attachments?: Array<DocumentAttachmentCreate> | null;

  billing_address?: string | null;

  billing_address_recipient?: string | null;

  /**
   * Currency of the invoice
   */
  currency?: CurrencyCode;

  customer_address?: string | null;

  customer_address_recipient?: string | null;

  customer_email?: string | null;

  customer_id?: string | null;

  customer_name?: string | null;

  customer_tax_id?: string | null;

  direction?: DocumentDirection;

  document_type?: DocumentType;

  due_date?: string | null;

  invoice_date?: string | null;

  invoice_id?: string | null;

  invoice_total?: number | string | null;

  items?: Array<DocumentCreateParams.Item> | null;

  note?: string | null;

  payment_details?: Array<PaymentDetailCreate> | null;

  payment_term?: string | null;

  previous_unpaid_balance?: number | string | null;

  purchase_order?: string | null;

  remittance_address?: string | null;

  remittance_address_recipient?: string | null;

  service_address?: string | null;

  service_address_recipient?: string | null;

  service_end_date?: string | null;

  service_start_date?: string | null;

  shipping_address?: string | null;

  shipping_address_recipient?: string | null;

  state?: InboxAPI.DocumentState;

  subtotal?: number | string | null;

  tax_details?: Array<DocumentCreateParams.TaxDetail> | null;

  total_discount?: number | string | null;

  total_tax?: number | string | null;

  vendor_address?: string | null;

  vendor_address_recipient?: string | null;

  vendor_email?: string | null;

  vendor_name?: string | null;

  vendor_tax_id?: string | null;
}

export namespace DocumentCreateParams {
  export interface Item {
    amount?: number | string | null;

    date?: null;

    description?: string | null;

    product_code?: string | null;

    quantity?: number | string | null;

    tax?: number | string | null;

    tax_rate?: string | null;

    /**
     * Unit of Measure Codes from UNECERec20 used in Peppol BIS Billing 3.0.
     */
    unit?: DocumentsAPI.UnitOfMeasureCode | null;

    unit_price?: number | string | null;
  }

  export interface TaxDetail {
    amount?: number | string | null;

    rate?: string | null;
  }
}

export interface DocumentSendParams {
  email?: string | null;

  receiver_peppol_id?: string | null;

  receiver_peppol_scheme?: string | null;

  sender_peppol_id?: string | null;

  sender_peppol_scheme?: string | null;
}

Documents.Attachments = Attachments;
Documents.Ubl = Ubl;

export declare namespace Documents {
  export {
    type CurrencyCode as CurrencyCode,
    type DocumentAttachmentCreate as DocumentAttachmentCreate,
    type DocumentCreate as DocumentCreate,
    type DocumentDirection as DocumentDirection,
    type DocumentResponse as DocumentResponse,
    type DocumentType as DocumentType,
    type PaymentDetailCreate as PaymentDetailCreate,
    type UnitOfMeasureCode as UnitOfMeasureCode,
    type DocumentDeleteResponse as DocumentDeleteResponse,
    type DocumentCreateParams as DocumentCreateParams,
    type DocumentSendParams as DocumentSendParams,
  };

  export {
    Attachments as Attachments,
    type DocumentAttachment as DocumentAttachment,
    type AttachmentListResponse as AttachmentListResponse,
    type AttachmentDeleteResponse as AttachmentDeleteResponse,
    type AttachmentRetrieveParams as AttachmentRetrieveParams,
    type AttachmentDeleteParams as AttachmentDeleteParams,
    type AttachmentAddParams as AttachmentAddParams,
  };

  export { Ubl as Ubl, type UblGetResponse as UblGetResponse };
}