openapi: 3.0.3 info: title: Fatture in Cloud API v2 - API Reference description: >- Connect your software with Fatture in Cloud, the invoicing platform chosen by more than 500.000 businesses in Italy. The Fatture in Cloud API is based on REST, and makes possible to interact with the user related data prior authorization via OAuth2 protocol. contact: name: Fatture in Cloud url: https://www.fattureincloud.it email: info@fattureincloud.it license: name: MIT url: >- https://github.com/fattureincloud/openapi-fattureincloud/blob/master/LICENSE version: 2.0.33 servers: - url: https://api-v2.fattureincloud.it tags: - name: Archive - name: Cashbook - name: Clients - name: Companies - name: Info - name: Issued Documents - name: Issued e-invoices - name: Products - name: Receipts - name: Received Documents - name: Suppliers - name: Taxes - name: User paths: /user/info: get: tags: - User summary: Get User Info responses: '200': $ref: '#/components/responses/GetUserInfoResponse' '401': description: Unauthorized. operationId: getUserInfo description: Gets the current user's info. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /user/companies: get: summary: List User Companies tags: - User responses: '200': $ref: '#/components/responses/ListUserCompaniesResponse' '401': description: Unauthorized operationId: listUserCompanies description: Lists the companies controlled by the current user. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /c/{company_id}/company/info: parameters: - $ref: '#/components/parameters/company_id' get: summary: Get Company Info responses: '200': $ref: '#/components/responses/GetCompanyInfoResponse' '401': description: Unauthorized. operationId: getCompanyInfo description: Gets the company detailed info. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] tags: - Companies /c/{company_id}/company/plan_usage: parameters: - $ref: '#/components/parameters/company_id' get: summary: Get Company Plan Usage responses: '200': $ref: '#/components/responses/GetCompanyPlanUsageResponse' '401': description: Unauthorized. operationId: getCompanyPlanUsage description: Gets the company limits usage. parameters: - schema: type: string enum: - clients - suppliers - products - documents in: query name: category description: Category required: true security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] tags: - Companies /c/{company_id}/entities/clients: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Clients tags: - Clients responses: '200': $ref: '#/components/responses/ListClientsResponse' '401': description: Unauthorized operationId: listClients description: Lists the clients. security: - OAuth2AuthenticationCodeFlow: - entity.clients:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' - $ref: '#/components/parameters/q' post: summary: Create Client operationId: createClient responses: '200': $ref: '#/components/responses/CreateClientResponse' description: Creates a new client. security: - OAuth2AuthenticationCodeFlow: - entity.clients:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: CreateClientRequest type: object properties: data: type: object title: Client properties: id: type: integer description: Client id code: type: string example: '123' description: Client code name: type: string example: Rossi S.r.l. description: Client name type: title: ClientType type: string default: null enum: - company - person - pa - condo description: Client type first_name: type: string description: Client first name last_name: type: string description: Client last name contact_person: type: string description: Client contact person vat_number: type: string example: IT01234567890 description: Client vat number tax_code: type: string example: RSSMRA44A12E890Q description: Client tax code address_street: type: string example: Via dei tigli, 12 description: Client address street address_postal_code: type: string example: '24010' description: Client address postal code address_city: type: string example: Bergamo description: Client address city address_province: type: string example: BG description: Client address province address_extra: type: string description: Client address extra info country: type: string example: Italia description: Client country default: Italia country_iso: type: string example: Italia description: Client country iso code email: type: string example: mario.rossi@example.it description: Client email certified_email: type: string example: mario.rossi@pec.example.it description: Client certified email phone: type: string description: Client phone fax: type: string description: Client fax notes: type: string description: Client extra default_vat: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 maximum: 100 minimum: 0 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true default: true is_disabled: type: boolean description: Is the vat type disabled required: - value default_payment_terms: type: integer example: 30 description: Client default payment terms default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method required: - name bank_name: type: string description: Client bank name bank_iban: type: string description: Client bank iban bank_swift_code: type: string description: Client bank swift code shipping_address: type: string description: Client shipping address e_invoice: type: boolean description: Use e-invoices for this entity default: false ei_code: type: string description: | Client e-invoice code discount_highlight: type: boolean description: Highlight Discount default_discount: type: number description: Client default discount has_intent_declaration: type: boolean description: Client has intent declaration intent_declaration_protocol_number: type: string description: Client intent declaration protocol number intent_declaration_protocol_date: type: string format: date description: Client intent declaration protocol date created_at: type: string description: Client creation date updated_at: type: string description: Client last update date required: - name examples: example-1: value: data: code: AE86 name: Avv. Maria Rossi type: person first_name: Maria last_name: Rossi contact_person: '' vat_number: IT12345640962 tax_code: BLTGNI5ABCDA794E address_street: Via Roma, 1 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia email: maria.rossi@example.com certified_email: maria.rossi@pec.example.com phone: '1234567890' fax: '' notes: '' default_payment_terms: 1 default_payment_terms_type: standard bank_name: Indesa bank_iban: IT40P123456781000000123456 bank_swift_code: AK86PCT shipping_address: Corso Magellano 4 e_invoice: true ei_code: '111111' default_vat: id: 54321 value: 45 description: '' is_disabled: false description: The client to create tags: - Clients /c/{company_id}/entities/clients/{client_id}: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/client_id' get: summary: Get Client tags: - Clients responses: '200': $ref: '#/components/responses/GetClientResponse' '401': description: Unauthorized '404': description: Not Found operationId: getClient security: - OAuth2AuthenticationCodeFlow: - entity.clients:r - ManualAuth: [] description: Gets the specified client. parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' put: summary: Modify Client operationId: modifyClient responses: '200': $ref: '#/components/responses/ModifyClientResponse' '401': description: Unauthorized '404': description: Not Found description: Modifies the specified client. security: - OAuth2AuthenticationCodeFlow: - entity.clients:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: ModifyClientRequest type: object properties: data: type: object title: Client properties: id: type: integer description: Client id code: type: string example: '123' description: Client code name: type: string example: Rossi S.r.l. description: Client name type: title: ClientType type: string default: null enum: - company - person - pa - condo description: Client type first_name: type: string description: Client first name last_name: type: string description: Client last name contact_person: type: string description: Client contact person vat_number: type: string example: IT01234567890 description: Client vat number tax_code: type: string example: RSSMRA44A12E890Q description: Client tax code address_street: type: string example: Via dei tigli, 12 description: Client address street address_postal_code: type: string example: '24010' description: Client address postal code address_city: type: string example: Bergamo description: Client address city address_province: type: string example: BG description: Client address province address_extra: type: string description: Client address extra info country: type: string example: Italia description: Client country default: Italia country_iso: type: string example: Italia description: Client country iso code email: type: string example: mario.rossi@example.it description: Client email certified_email: type: string example: mario.rossi@pec.example.it description: Client certified email phone: type: string description: Client phone fax: type: string description: Client fax notes: type: string description: Client extra default_vat: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 maximum: 100 minimum: 0 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true default: true is_disabled: type: boolean description: Is the vat type disabled required: - value default_payment_terms: type: integer example: 30 description: Client default payment terms default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method required: - name bank_name: type: string description: Client bank name bank_iban: type: string description: Client bank iban bank_swift_code: type: string description: Client bank swift code shipping_address: type: string description: Client shipping address e_invoice: type: boolean description: Use e-invoices for this entity default: false ei_code: type: string description: | Client e-invoice code discount_highlight: type: boolean description: Highlight Discount default_discount: type: number description: Client default discount has_intent_declaration: type: boolean description: Client has intent declaration intent_declaration_protocol_number: type: string description: Client intent declaration protocol number intent_declaration_protocol_date: type: string format: date description: Client intent declaration protocol date created_at: type: string description: Client creation date updated_at: type: string description: Client last update date required: - name description: '' examples: example-1: value: data: code: AE86 name: Avv. Maria Rossi type: person first_name: Maria last_name: Rossi contact_person: '' vat_number: IT12345640962 tax_code: BLTGNI5ABCDA794E address_street: Via Roma, 1 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia email: maria.rossi@example.com certified_email: maria.rossi@pec.example.com phone: '1234567890' fax: '' notes: '' default_payment_terms: 1 default_payment_terms_type: standard bank_name: Indesa bank_iban: IT40P123456781000000123456 bank_swift_code: AK86PCT shipping_address: Corso Magellano 4 e_invoice: true ei_code: '111111' default_vat: id: 54321 value: 45 description: '' is_disabled: false description: The modified Client. First level parameters are managed in delta mode. tags: - Clients delete: summary: Delete Client operationId: deleteClient responses: '200': description: Entity Removed '401': description: Unauthorized '404': description: Not Found description: Deletes the specified client. parameters: [] security: - OAuth2AuthenticationCodeFlow: - entity.clients:a - ManualAuth: [] tags: - Clients /c/{company_id}/entities/suppliers: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Suppliers responses: '200': $ref: '#/components/responses/ListSuppliersResponse' '401': description: Unauthorized operationId: listSuppliers description: Lists the suppliers. security: - OAuth2AuthenticationCodeFlow: - entity.suppliers:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' - $ref: '#/components/parameters/q' tags: - Suppliers post: summary: Create Supplier operationId: createSupplier responses: '200': $ref: '#/components/responses/CreateSupplierResponse' description: Creates a new supplier. security: - OAuth2AuthenticationCodeFlow: - entity.suppliers:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: CreateSupplierRequest type: object properties: data: type: object title: Supplier properties: id: type: integer description: Supplier id code: type: string example: '123' description: Supplier code name: type: string example: Rossi S.r.l. description: Supplier name type: title: SupplierType type: string default: null enum: - company - person - pa - condo description: Supplier type first_name: type: string description: Supplier first name last_name: type: string description: Supplier last name contact_person: type: string description: Supplier contact person vat_number: type: string example: IT01234567890 description: Supplier vat number tax_code: type: string example: RSSMRA44A12E890Q description: Supplier tax code address_street: type: string example: Via dei tigli, 12 description: Supplier street address address_postal_code: type: string example: '24010' description: Supplier postal code address_city: type: string example: Bergamo description: Supplier city address_province: type: string example: BG description: Supplier province address_extra: type: string description: Supplier address extra info country: type: string example: Italia description: Supplier country default: Italia country_iso: type: string example: Italia description: Supplier country iso code email: type: string example: mario.rossi@example.it description: Supplier email certified_email: type: string example: mario.rossi@pec.example.it description: Supplier certified email phone: type: string description: Supplier phone fax: type: string description: Supplier fax notes: type: string description: Supplier extra notes bank_iban: type: string description: Supplier bank IBAN created_at: type: string description: Supplier creation date updated_at: type: string description: Supplier last update date required: - name examples: example-1: value: data: id: 12345 code: AE86 name: Mario Rossi S.R.L. type: company first_name: Mario last_name: Rossi contact_person: '' vat_number: '111222333' tax_code: '111122233' address_street: Corso Magellano, 46 address_postal_code: '20146' address_city: Milano address_province: MI address_extra: '' country: Italia email: mario.rossi@example.com certified_email: mario.rossi@pec.example.com phone: '1234567890' fax: '123456789' notes: '' description: The supplier to create tags: - Suppliers /c/{company_id}/entities/suppliers/{supplier_id}: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/supplier_id' get: summary: Get Supplier responses: '200': $ref: '#/components/responses/GetSupplierResponse' '401': description: Unauthorized '404': description: Not Found operationId: getSupplier security: - OAuth2AuthenticationCodeFlow: - entity.suppliers:r - ManualAuth: [] description: Gets the specified supplier. parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' tags: - Suppliers put: summary: Modify Supplier operationId: modifySupplier responses: '200': $ref: '#/components/responses/ModifySupplierResponse' '401': description: Unauthorized '404': description: Not Found description: Modifies the specified supplier. security: - OAuth2AuthenticationCodeFlow: - entity.suppliers:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: ModifySupplierRequest type: object properties: data: type: object title: Supplier properties: id: type: integer description: Supplier id code: type: string example: '123' description: Supplier code name: type: string example: Rossi S.r.l. description: Supplier name type: title: SupplierType type: string default: null enum: - company - person - pa - condo description: Supplier type first_name: type: string description: Supplier first name last_name: type: string description: Supplier last name contact_person: type: string description: Supplier contact person vat_number: type: string example: IT01234567890 description: Supplier vat number tax_code: type: string example: RSSMRA44A12E890Q description: Supplier tax code address_street: type: string example: Via dei tigli, 12 description: Supplier street address address_postal_code: type: string example: '24010' description: Supplier postal code address_city: type: string example: Bergamo description: Supplier city address_province: type: string example: BG description: Supplier province address_extra: type: string description: Supplier address extra info country: type: string example: Italia description: Supplier country default: Italia country_iso: type: string example: Italia description: Supplier country iso code email: type: string example: mario.rossi@example.it description: Supplier email certified_email: type: string example: mario.rossi@pec.example.it description: Supplier certified email phone: type: string description: Supplier phone fax: type: string description: Supplier fax notes: type: string description: Supplier extra notes bank_iban: type: string description: Supplier bank IBAN created_at: type: string description: Supplier creation date updated_at: type: string description: Supplier last update date required: - name examples: example-1: value: data: id: 12345 code: AE86 name: Mario Rossi S.R.L. type: company first_name: Mario last_name: Rossi contact_person: '' vat_number: '111222333' tax_code: '111122233' address_street: Corso Magellano, 46 address_postal_code: '20146' address_city: Milano address_province: MI address_extra: '' country: Italia email: mario.rossi@example.com certified_email: mario.rossi@pec.example.com phone: '1234567890' fax: '123456789' notes: '' description: >- The modified Supplier. First level parameters are managed in delta mode. tags: - Suppliers delete: summary: Delete Supplier operationId: deleteSupplier responses: '200': description: Entity Removed '401': description: Unauthorized '404': description: Not Found description: Deletes the specified supplier. parameters: [] security: - OAuth2AuthenticationCodeFlow: - entity.suppliers:a - ManualAuth: [] tags: - Suppliers /c/{company_id}/products: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Products tags: - Products responses: '200': $ref: '#/components/responses/ListProductsResponse' '401': description: Unauthorized operationId: listProducts description: Lists the products. security: - OAuth2AuthenticationCodeFlow: - products:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' - $ref: '#/components/parameters/q' post: summary: Create Product operationId: createProduct responses: '200': $ref: '#/components/responses/CreateProductResponse' tags: - Products description: Creates a new product. security: - OAuth2AuthenticationCodeFlow: - products:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: CreateProductRequest type: object properties: data: type: object title: Product properties: id: type: integer description: Product id name: type: string description: Product name code: type: string description: Product code net_price: type: number description: Product net price gross_price: type: number description: Product gross price use_gross_price: type: boolean description: Product uses gross prices default_vat: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 maximum: 100 minimum: 0 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true default: true is_disabled: type: boolean description: Is the vat type disabled required: - value net_cost: type: number description: Product net cost measure: type: string description: Product measure description: type: string description: Product description category: type: string description: Product category notes: type: string description: Product extra notes in_stock: type: boolean description: Product has stock stock_initial: type: number description: Product initial stock stock_current: type: number description: |- [Read Only] Product current stock readOnly: true average_cost: type: number description: Product average cost average_price: type: number description: Product average price created_at: type: string description: Product creation date updated_at: type: string description: Product last update date required: - name examples: example-1: value: data: name: Tavolo di marmo code: TAVOLO003 net_price: 240 net_cost: 0 measure: '' description: Tavolo in marmo pregiato category: arredamento in_stock: true default_vat: id: 3 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 is_disabled: false description: '' /c/{company_id}/products/{product_id}: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/product_id' get: summary: Get Product tags: - Products responses: '200': $ref: '#/components/responses/GetProductResponse' '401': description: Unauthorized '404': description: Not Found operationId: getProduct description: Gets the specified product. security: - OAuth2AuthenticationCodeFlow: - products:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' put: summary: Modify Product operationId: modifyProduct responses: '200': $ref: '#/components/responses/ModifyProductResponse' '401': description: Unauthorized '404': description: Not Found description: Modifies the specified product. security: - OAuth2AuthenticationCodeFlow: - products:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: ModifyProductRequest type: object properties: data: type: object title: Product properties: id: type: integer description: Product id name: type: string description: Product name code: type: string description: Product code net_price: type: number description: Product net price gross_price: type: number description: Product gross price use_gross_price: type: boolean description: Product uses gross prices default_vat: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 maximum: 100 minimum: 0 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true default: true is_disabled: type: boolean description: Is the vat type disabled required: - value net_cost: type: number description: Product net cost measure: type: string description: Product measure description: type: string description: Product description category: type: string description: Product category notes: type: string description: Product extra notes in_stock: type: boolean description: Product has stock stock_initial: type: number description: Product initial stock stock_current: type: number description: |- [Read Only] Product current stock readOnly: true average_cost: type: number description: Product average cost average_price: type: number description: Product average price created_at: type: string description: Product creation date updated_at: type: string description: Product last update date required: - name examples: example-1: value: data: name: Tavolo di marmo code: TAVOLO003 net_price: 240 net_cost: 0 measure: '' description: Tavolo in marmo pregiato category: arredamento in_stock: true default_vat: id: 3 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 is_disabled: false description: Modified product details. tags: - Products delete: summary: Delete Product operationId: deleteProduct responses: '200': description: Product removed. '401': description: Unauthorized '404': description: Not Found description: Deletes the specified product. security: - OAuth2AuthenticationCodeFlow: - products:a - ManualAuth: [] parameters: [] tags: - Products /c/{company_id}/issued_documents: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Issued Documents tags: - Issued Documents responses: '200': $ref: '#/components/responses/ListIssuedDocumentsResponse' '401': description: Unauthorized '404': description: Not Found operationId: listIssuedDocuments description: Lists the issued documents. security: - OAuth2AuthenticationCodeFlow: - issued_documents.invoices:r - issued_documents.credit_notes:r - issued_documents.receipts:r - issued_documents.orders:r - issued_documents.quotes:r - issued_documents.proformas:r - issued_documents.delivery_notes:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/issued_document_type' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' - $ref: '#/components/parameters/q' - schema: type: integer enum: - 0 - 1 in: query name: inclusive description: (Only for type = delivery_notes) Include invoices delivery notes. post: summary: Create Issued Document operationId: createIssuedDocument responses: '200': $ref: '#/components/responses/CreateIssuedDocumentResponse' '401': description: Unauthorized tags: - Issued Documents description: Creates a new document. security: - OAuth2AuthenticationCodeFlow: - issued_documents.invoices:a - issued_documents.credit_notes:a - issued_documents.receipts:a - issued_documents.orders:a - issued_documents.quotes:a - issued_documents.proformas:a - issued_documents.delivery_notes:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: CreateIssuedDocumentRequest type: object properties: data: title: IssuedDocument type: object properties: id: type: integer description: Issued document id entity: title: Entity type: object properties: id: type: integer description: Entity id code: type: string example: '123' description: Entity code name: type: string example: Rossi S.r.l. description: Entity name type: title: EntityType type: string default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name last_name: type: string description: Entity last name contact_person: type: string description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code address_street: type: string example: Via dei tigli, 12 description: Entitity address street address_postal_code: type: string example: '24010' description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city address_province: type: string example: BG description: Entity address province address_extra: type: string description: Entity address extra info country: type: string example: Italia description: Entity country default: Italia country_iso: type: string example: Italia description: Entity country iso code email: type: string example: mario.rossi@example.it description: Entity email certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email phone: type: string description: Entity phone fax: type: string description: Entity fax notes: type: string description: Entity extra default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms default_vat: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 maximum: 100 minimum: 0 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true default: true is_disabled: type: boolean description: Is the vat type disabled description: |- [Only for client] Client default vat. required: - value default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method description: |- [Only for client] Client default payment method required: - name bank_name: type: string description: |- [Only for client] Client bank name bank_iban: type: string description: |- [Only for client] Client bank iban bank_swift_code: type: string description: |- [Only for client] Client bank swift code shipping_address: type: string description: |- [Only for client] Client Shipping address e_invoice: type: boolean description: |- [Only for client] Use e-invoices. default: false ei_code: type: string description: |- [Only for client] E-invoices code. has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date created_at: type: string description: Entity creation date updated_at: type: string description: Entity last update date required: - name type: type: string default: invoice enum: - invoice - quote - proforma - receipt - delivery_note - credit_note - order - work_report - supplier_order - self_own_invoice - self_supplier_invoice description: Issued document type number: type: integer description: |- Issued document number [If not specified, next number is used] example: 1 numeration: type: string description: |- Issued document numeration [Not available if type=delivery_note] example: /A date: type: string description: |- Issued document date [defaults to today's date] format: date year: type: integer description: Issued document year currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR symbol: type: string description: Currency symbol example: € exchange_rate: type: string description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code language: type: object title: Language properties: code: type: string description: Language code name: type: string description: Language extended name required: - code - name subject: type: string description: Issued document subject visible_subject: type: string description: Issued document visible subject rc_center: type: string description: >- Issued document revenue center [or cost center if type=supplier_order]. notes: type: string description: Issued document extra notes rivalsa: type: number description: Issued document "Rivalsa INPS" percentual value maximum: 100 minimum: 0 cassa: type: number description: Issued document "Cassa previdenziale" percentual value maximum: 100 minimum: 0 amount_cassa: type: number description: |- [Read Only] Issued document cassa amount. readOnly: true cassa_taxable: type: number description: Issued document cassa taxable percentage minimum: 0 maximum: 100 amount_cassa_taxable: type: number description: |- [Can be set only if cassa_taxable is NULL] Issued document cassa taxable amount cassa2: type: number description: Issued document "Cassa previdenziale 2" percentual value maximum: 100 minimum: 0 amount_cassa2: type: number description: |- [Read Only] Issued document cassa2 amount readOnly: true cassa2_taxable: type: number description: Issued document cassa2 taxable percentage minimum: 0 maximum: 100 amount_cassa2_taxable: type: number description: |- [Can be set only if cassa2_taxable is NULL] Issued document cassa2 taxable amount global_cassa_taxable: type: number description: Issued document global cassa taxable percentage minimum: 0 maximum: 100 amount_global_cassa_taxable: type: number description: |- [Can be set only if global_cassa_taxable is NULL] Issued document global cassa taxable amount withholding_tax: type: number description: >- Issued document withholding tax (ritenuta d'acconto) percentual value maximum: 100 minimum: 0 withholding_tax_taxable: type: number description: >- Issued document withholding tax taxable (imponibile) percentual value maximum: 100 minimum: 0 other_withholding_tax: type: number description: >- Issued document other withholding tax (altra ritenuta) percentual value maximum: 100 minimum: 0 stamp_duty: type: number description: |- Issued document stamp duty value [0 if not present] payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method required: - name use_split_payment: type: boolean description: Issued document uses split payment default: false use_gross_prices: type: boolean description: Issued document uses gross prices default: false e_invoice: type: boolean description: Issued document is an e-invoice. default: false ei_data: type: object description: |- Issued document e-invoice data [Only if e_invoice=true] properties: vat_kind: title: VatKind type: string description: Vat kind [esigibilità IVA] default: null enum: - null - I - D - S original_document_type: title: OriginalDocumentType type: string description: Issued document original document type default: ordine enum: - ordine - contratto - convenzione od_number: type: string description: E-invoice original document number od_date: type: string description: E-invoice original document date format: date cig: type: string description: E-invoice CIG cup: type: string description: E-invoice CUP payment_method: type: string description: >- E-invoice payment method [required for e-invoices] (see [here](https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.2/Rappresentazione_Tabellare_FattOrdinaria_V1.2.2.pdf) for the accepted values of ModalitaPagamento) bank_name: type: string description: E-invoice bank name bank_iban: type: string description: E-invoice bank IBAN bank_beneficiary: type: string description: E-invoice bank beneficiary invoice_number: type: string description: E-invoice invoice number invoice_date: type: string format: date description: E-invoice invoice date ei_cassa_type: type: string description: E-invoice cassa type ei_cassa2_type: type: string description: E-invoice cassa2 type ei_withholding_tax_causal: type: string description: E-invoice withholding tax causal ei_other_withholding_tax_type: type: string description: E-invoice other withholding tax type ei_other_withholding_tax_causal: type: string description: E-invoice other withholding tax causal items_list: type: array items: title: IssuedDocumentItemsListItem type: object properties: id: type: integer description: Issued document item id nullable: true product_id: type: integer nullable: true description: Issued document item product id example: 1234 code: type: string description: Issued document item product code example: '239874892374982' nullable: true name: type: string description: Issued document item product name example: Water bottle nullable: true category: type: string description: Issued document item product category nullable: true description: type: string description: Issued document product description nullable: true qty: type: number description: Issued document item quantity nullable: true measure: type: string description: Issued document item measure nullable: true net_price: type: number description: Issued document item net price example: 1.23 nullable: true gross_price: type: number nullable: true example: 1.45 description: Issued document item gross price vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true not_taxable: type: boolean nullable: true description: Issued document item is not taxable apply_withholding_taxes: type: boolean description: >- Issued document item apply withholding taxes, rivalsa and cassa nullable: true discount: type: number description: Issued document item discount percentual value nullable: true discount_highlight: type: boolean nullable: true description: Issued document item highlight discount in_dn: type: boolean nullable: true description: Issued document item add in delivery note stock: type: boolean nullable: true description: Issued document item move stock ei_raw: type: object description: >- Issued document advanced raw attributes for e-invoices nullable: true payments_list: type: array items: title: IssuedDocumentPaymentsListItem type: object properties: id: type: integer description: Issued document payment item id nullable: true due_date: type: string description: Issued document payment due date format: date example: '2018-04-03' nullable: true amount: type: number description: Issued document payment amount example: 1.45 nullable: true status: title: IssuedDocumentStatus type: string description: Issued document status default: not_paid enum: - not_paid - paid - reversed payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true paid_date: type: string description: |- Issued document payment date [Only if status is paid] format: date example: '2018-04-03' nullable: true ei_raw: type: object nullable: true description: >- Issued document payment advanced raw attributes for e-invoices payment_terms: type: object properties: days: type: integer nullable: true description: >- Issued document payment number of days by which the payment must be made type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 name: type: string example: Light Smoke description: Template name type: type: string description: Template type delivery_note_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 name: type: string example: Light Smoke description: Template name type: type: string description: Template type acc_inv_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 name: type: string example: Light Smoke description: Template name type: type: string description: Template type h_margins: type: integer description: Issued document PDF horizontal margins v_margins: type: integer description: Issued document PDF vertical margins show_payments: type: boolean description: >- Show the expiration dates of the payments on the document show_payment_method: type: boolean description: Show the payment method details on the document show_totals: title: ShowTotalsMode type: string description: Show totals mode default: all enum: - none - nets - all show_notification_button: type: boolean description: Show notification button in the PDF default: false show_tspay_button: type: boolean description: Show ts pay button in the PDF delivery_note: type: boolean description: Issued document has delivery note accompanying_invoice: type: boolean description: Issued document has an accompanying invoice default: false dn_number: type: integer description: Issued document attached delivery note number dn_date: type: string description: Issued document attached delivery note date format: date dn_ai_packages_number: type: string description: >- Issued document attached delivery note number of packages dn_ai_weight: type: string description: Issued document attached delivery note package weight dn_ai_causal: type: string description: Issued document attached delivery note causal dn_ai_destination: type: string description: Issued document attached delivery note destination dn_ai_transporter: type: string description: Issued document attached delivery note transporter dn_ai_notes: type: string description: Issued document attached delivery note notes is_marked: type: boolean description: Issued document is marked amount_net: type: number description: |- [Read only] Issued document total net amount readOnly: true amount_vat: type: number description: |- [Read Only] Issued document total vat amount readOnly: true amount_gross: type: number description: |- [Read Only] Issued document total gross amount readOnly: true amount_due_discount: type: number description: Issued document amount due discount amount_rivalsa: type: number description: |- [Read Only] Issued document rivalsa amount readOnly: true amount_rivalsa_taxable: type: number description: Issued document taxable rivalsa amount amount_withholding_tax: type: number description: >- [Read Only] Issued document withholding tax amount (ritenuta d'acconto). readOnly: true amount_withholding_tax_taxable: type: number description: Issued document taxable withholding tax amount amount_other_withholding_tax: type: number description: >- [Read Only] Issued document other withholding tax amount (altra ritenuta) readOnly: true amount_other_withholding_tax_taxable: type: number description: Issued document taxable other withholding tax amount amount_enasarco_taxable: type: number description: Issued document taxable enasarco amount extra_data: type: object description: >- Issued document extra data [TS fields follow the technical specifications provided by "Sistema Tessera Sanitaria"] properties: multifatture_sent: type: integer ts_communication: type: boolean description: Send issued document to "Sistema Tessera Sanitaria" ts_flag_tipo_spesa: type: number description: >- Issued document ts "tipo spesa" [TK, FC, FV, SV,SP, AD, AS, ECG, SR] ts_pagamento_tracciato: type: boolean description: Issued document ts traced payment ts_tipo_spesa: type: string description: >- Can be [ 'TK', 'FC', 'FV', 'SV', 'SP', 'AD', 'AS', 'SR', 'CT', 'PI', 'IC', 'AA' ]. Refer to the technical specifications to learn more. ts_opposizione: type: boolean description: Issued document ts "opposizione" ts_status: type: integer description: Issued document ts status ts_file_id: type: string description: Issued document ts file id ts_sent_date: type: string format: date description: Issued document ts sent date ts_full_amount: type: boolean description: Issued document ts total amount imported_by: type: string description: Issued document imported by software seen_date: type: string description: Issued document seen date format: date next_due_date: type: string description: Issued document date of the next not paid payment format: date url: type: string description: |- [Temporary] [Read Only] Issued document url of the document PDF file dn_url: type: string description: >- [Temporary] [Read Only] Issued document url of the attached delivery note PDF file ai_url: type: string description: |- [Temporary] [Read Only] Issued document url of the accompanying invoice PDF file attachment_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached file readOnly: true attachment_token: type: string description: >- [Write Only] Issued document attachment token returned by POST /issued_documents/attachment writeOnly: true ei_raw: type: object description: Issued document advanced raw attributes for e-invoices ei_status: type: string description: | [Read only] Status of the e-invoice. * **attempt** - We are trying to send the invoice, please wait up to 2 hours * **missing** - The invoice is missing * **not_sent** - The invoice has yet to be sent * **sent** - The invoice was sent * **pending** - The checks for the digital signature and sending are in progress * **processing** - The SDI is delivering the invoice to the customer * **error** - An error occurred while handling the invoice, please try to resend it or contact support * **discarded** - The invoice has been rejected by the SDI, so it must be corrected and re-sent * **not_delivered** - The SDI was unable to deliver the invoice * **accepted** - The customer accepted the invoice * **rejected** - The customer rejected the invoice, so it must be corrected * **no_response** - A response has not yet been received whithin the deadline, contact the customer to ascertain the status of the invoice * **manual_accepted** - The customer accepted the invoice * **manual_rejected** - The customer rejected the invoice enum: - attempt - missing - not_sent - sent - pending - processing - error - discarded - not_delivered - accepted - rejected - no_response - manual_accepted - manual_rejected locked: type: boolean description: Issued Document can't be edited created_at: type: string description: Issued document creation date updated_at: type: string description: Issued document last update date options: title: IssuedDocumentOptions type: object properties: fix_payments: type: boolean description: >- Fixes your last payment amount to match your document total create_from: type: array description: Original documents ids [only for join/transform] items: type: string transform: type: boolean description: Tranform a document [only for transform] keep_copy: type: boolean description: Keep original document [only for transform] join_type: type: string description: Join type [only for join] examples: example-1: value: data: type: receipt numeration: rec123 subject: '' visible_subject: '' amount_net: 68.18 amount_vat: 6.82 amount_due_discount: 0 entity: id: 54321 name: Mary Red S.r.L. vat_number: IT05432181211 tax_code: IT05432181211 address_street: Via Italia, 66 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia certified_email: mary@pec.red.com ei_code: ABCXCR1 date: '2021-08-20' number: 1 next_due_date: '2021-12-31' attachment_token: ypbqqe4u8w8bdabcd5fd5b1a items_list: - product_id: 333 code: SG3 name: Soggiorno measure: '' net_price: 68.18182 category: '' id: 277875565 gross_price: 75 apply_withholding_taxes: true discount: 0 discount_highlight: false in_dn: false qty: 1 vat: id: 3 value: 10 description: '' stock: true description: '' not_taxable: false payments_list: - amount: 75 due_date: '2020-08-23' id: 444 payment_terms: days: 0 type: standard status: not_paid payment_method: id: 4 description: The Issued Document /c/{company_id}/issued_documents/{document_id}: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' get: summary: Get Issued Document tags: - Issued Documents responses: '200': $ref: '#/components/responses/GetIssuedDocumentResponse' '401': description: Unauthorized '404': description: Not Found operationId: getIssuedDocument description: | Gets the specified document. security: - OAuth2AuthenticationCodeFlow: - issued_documents.invoices:r - issued_documents.credit_notes:r - issued_documents.receipts:r - issued_documents.orders:r - issued_documents.quotes:r - issued_documents.proformas:r - issued_documents.delivery_notes:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' put: summary: Modify Issued Document operationId: modifyIssuedDocument responses: '200': $ref: '#/components/responses/ModifyIssuedDocumentResponse' '401': description: Unauthorized '404': description: Not Found description: Modifies the specified document. security: - OAuth2AuthenticationCodeFlow: - issued_documents.invoices:a - issued_documents.credit_notes:a - issued_documents.receipts:a - issued_documents.orders:a - issued_documents.quotes:a - issued_documents.proformas:a - issued_documents.delivery_notes:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: ModifyIssuedDocumentRequest type: object description: '' properties: data: title: IssuedDocument type: object properties: id: type: integer description: Issued document id entity: title: Entity type: object properties: id: type: integer description: Entity id code: type: string example: '123' description: Entity code name: type: string example: Rossi S.r.l. description: Entity name type: title: EntityType type: string default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name last_name: type: string description: Entity last name contact_person: type: string description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code address_street: type: string example: Via dei tigli, 12 description: Entitity address street address_postal_code: type: string example: '24010' description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city address_province: type: string example: BG description: Entity address province address_extra: type: string description: Entity address extra info country: type: string example: Italia description: Entity country default: Italia country_iso: type: string example: Italia description: Entity country iso code email: type: string example: mario.rossi@example.it description: Entity email certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email phone: type: string description: Entity phone fax: type: string description: Entity fax notes: type: string description: Entity extra default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms default_vat: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 maximum: 100 minimum: 0 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true default: true is_disabled: type: boolean description: Is the vat type disabled description: |- [Only for client] Client default vat. required: - value default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method description: |- [Only for client] Client default payment method required: - name bank_name: type: string description: |- [Only for client] Client bank name bank_iban: type: string description: |- [Only for client] Client bank iban bank_swift_code: type: string description: |- [Only for client] Client bank swift code shipping_address: type: string description: |- [Only for client] Client Shipping address e_invoice: type: boolean description: |- [Only for client] Use e-invoices. default: false ei_code: type: string description: |- [Only for client] E-invoices code. has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date created_at: type: string description: Entity creation date updated_at: type: string description: Entity last update date required: - name type: type: string default: invoice enum: - invoice - quote - proforma - receipt - delivery_note - credit_note - order - work_report - supplier_order - self_own_invoice - self_supplier_invoice description: Issued document type number: type: integer description: |- Issued document number [If not specified, next number is used] example: 1 numeration: type: string description: |- Issued document numeration [Not available if type=delivery_note] example: /A date: type: string description: |- Issued document date [defaults to today's date] format: date year: type: integer description: Issued document year currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR symbol: type: string description: Currency symbol example: € exchange_rate: type: string description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code language: type: object title: Language properties: code: type: string description: Language code name: type: string description: Language extended name required: - code - name subject: type: string description: Issued document subject visible_subject: type: string description: Issued document visible subject rc_center: type: string description: >- Issued document revenue center [or cost center if type=supplier_order]. notes: type: string description: Issued document extra notes rivalsa: type: number description: Issued document "Rivalsa INPS" percentual value maximum: 100 minimum: 0 cassa: type: number description: Issued document "Cassa previdenziale" percentual value maximum: 100 minimum: 0 amount_cassa: type: number description: |- [Read Only] Issued document cassa amount. readOnly: true cassa_taxable: type: number description: Issued document cassa taxable percentage minimum: 0 maximum: 100 amount_cassa_taxable: type: number description: |- [Can be set only if cassa_taxable is NULL] Issued document cassa taxable amount cassa2: type: number description: Issued document "Cassa previdenziale 2" percentual value maximum: 100 minimum: 0 amount_cassa2: type: number description: |- [Read Only] Issued document cassa2 amount readOnly: true cassa2_taxable: type: number description: Issued document cassa2 taxable percentage minimum: 0 maximum: 100 amount_cassa2_taxable: type: number description: |- [Can be set only if cassa2_taxable is NULL] Issued document cassa2 taxable amount global_cassa_taxable: type: number description: Issued document global cassa taxable percentage minimum: 0 maximum: 100 amount_global_cassa_taxable: type: number description: |- [Can be set only if global_cassa_taxable is NULL] Issued document global cassa taxable amount withholding_tax: type: number description: >- Issued document withholding tax (ritenuta d'acconto) percentual value maximum: 100 minimum: 0 withholding_tax_taxable: type: number description: >- Issued document withholding tax taxable (imponibile) percentual value maximum: 100 minimum: 0 other_withholding_tax: type: number description: >- Issued document other withholding tax (altra ritenuta) percentual value maximum: 100 minimum: 0 stamp_duty: type: number description: |- Issued document stamp duty value [0 if not present] payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method required: - name use_split_payment: type: boolean description: Issued document uses split payment default: false use_gross_prices: type: boolean description: Issued document uses gross prices default: false e_invoice: type: boolean description: Issued document is an e-invoice. default: false ei_data: type: object description: |- Issued document e-invoice data [Only if e_invoice=true] properties: vat_kind: title: VatKind type: string description: Vat kind [esigibilità IVA] default: null enum: - null - I - D - S original_document_type: title: OriginalDocumentType type: string description: Issued document original document type default: ordine enum: - ordine - contratto - convenzione od_number: type: string description: E-invoice original document number od_date: type: string description: E-invoice original document date format: date cig: type: string description: E-invoice CIG cup: type: string description: E-invoice CUP payment_method: type: string description: >- E-invoice payment method [required for e-invoices] (see [here](https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.2/Rappresentazione_Tabellare_FattOrdinaria_V1.2.2.pdf) for the accepted values of ModalitaPagamento) bank_name: type: string description: E-invoice bank name bank_iban: type: string description: E-invoice bank IBAN bank_beneficiary: type: string description: E-invoice bank beneficiary invoice_number: type: string description: E-invoice invoice number invoice_date: type: string format: date description: E-invoice invoice date ei_cassa_type: type: string description: E-invoice cassa type ei_cassa2_type: type: string description: E-invoice cassa2 type ei_withholding_tax_causal: type: string description: E-invoice withholding tax causal ei_other_withholding_tax_type: type: string description: E-invoice other withholding tax type ei_other_withholding_tax_causal: type: string description: E-invoice other withholding tax causal items_list: type: array items: title: IssuedDocumentItemsListItem type: object properties: id: type: integer description: Issued document item id nullable: true product_id: type: integer nullable: true description: Issued document item product id example: 1234 code: type: string description: Issued document item product code example: '239874892374982' nullable: true name: type: string description: Issued document item product name example: Water bottle nullable: true category: type: string description: Issued document item product category nullable: true description: type: string description: Issued document product description nullable: true qty: type: number description: Issued document item quantity nullable: true measure: type: string description: Issued document item measure nullable: true net_price: type: number description: Issued document item net price example: 1.23 nullable: true gross_price: type: number nullable: true example: 1.45 description: Issued document item gross price vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true not_taxable: type: boolean nullable: true description: Issued document item is not taxable apply_withholding_taxes: type: boolean description: >- Issued document item apply withholding taxes, rivalsa and cassa nullable: true discount: type: number description: Issued document item discount percentual value nullable: true discount_highlight: type: boolean nullable: true description: Issued document item highlight discount in_dn: type: boolean nullable: true description: Issued document item add in delivery note stock: type: boolean nullable: true description: Issued document item move stock ei_raw: type: object description: >- Issued document advanced raw attributes for e-invoices nullable: true payments_list: type: array items: title: IssuedDocumentPaymentsListItem type: object properties: id: type: integer description: Issued document payment item id nullable: true due_date: type: string description: Issued document payment due date format: date example: '2018-04-03' nullable: true amount: type: number description: Issued document payment amount example: 1.45 nullable: true status: title: IssuedDocumentStatus type: string description: Issued document status default: not_paid enum: - not_paid - paid - reversed payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true paid_date: type: string description: |- Issued document payment date [Only if status is paid] format: date example: '2018-04-03' nullable: true ei_raw: type: object nullable: true description: >- Issued document payment advanced raw attributes for e-invoices payment_terms: type: object properties: days: type: integer nullable: true description: >- Issued document payment number of days by which the payment must be made type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 name: type: string example: Light Smoke description: Template name type: type: string description: Template type delivery_note_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 name: type: string example: Light Smoke description: Template name type: type: string description: Template type acc_inv_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 name: type: string example: Light Smoke description: Template name type: type: string description: Template type h_margins: type: integer description: Issued document PDF horizontal margins v_margins: type: integer description: Issued document PDF vertical margins show_payments: type: boolean description: >- Show the expiration dates of the payments on the document show_payment_method: type: boolean description: Show the payment method details on the document show_totals: title: ShowTotalsMode type: string description: Show totals mode default: all enum: - none - nets - all show_notification_button: type: boolean description: Show notification button in the PDF default: false show_tspay_button: type: boolean description: Show ts pay button in the PDF delivery_note: type: boolean description: Issued document has delivery note accompanying_invoice: type: boolean description: Issued document has an accompanying invoice default: false dn_number: type: integer description: Issued document attached delivery note number dn_date: type: string description: Issued document attached delivery note date format: date dn_ai_packages_number: type: string description: >- Issued document attached delivery note number of packages dn_ai_weight: type: string description: Issued document attached delivery note package weight dn_ai_causal: type: string description: Issued document attached delivery note causal dn_ai_destination: type: string description: Issued document attached delivery note destination dn_ai_transporter: type: string description: Issued document attached delivery note transporter dn_ai_notes: type: string description: Issued document attached delivery note notes is_marked: type: boolean description: Issued document is marked amount_net: type: number description: |- [Read only] Issued document total net amount readOnly: true amount_vat: type: number description: |- [Read Only] Issued document total vat amount readOnly: true amount_gross: type: number description: |- [Read Only] Issued document total gross amount readOnly: true amount_due_discount: type: number description: Issued document amount due discount amount_rivalsa: type: number description: |- [Read Only] Issued document rivalsa amount readOnly: true amount_rivalsa_taxable: type: number description: Issued document taxable rivalsa amount amount_withholding_tax: type: number description: >- [Read Only] Issued document withholding tax amount (ritenuta d'acconto). readOnly: true amount_withholding_tax_taxable: type: number description: Issued document taxable withholding tax amount amount_other_withholding_tax: type: number description: >- [Read Only] Issued document other withholding tax amount (altra ritenuta) readOnly: true amount_other_withholding_tax_taxable: type: number description: Issued document taxable other withholding tax amount amount_enasarco_taxable: type: number description: Issued document taxable enasarco amount extra_data: type: object description: >- Issued document extra data [TS fields follow the technical specifications provided by "Sistema Tessera Sanitaria"] properties: multifatture_sent: type: integer ts_communication: type: boolean description: Send issued document to "Sistema Tessera Sanitaria" ts_flag_tipo_spesa: type: number description: >- Issued document ts "tipo spesa" [TK, FC, FV, SV,SP, AD, AS, ECG, SR] ts_pagamento_tracciato: type: boolean description: Issued document ts traced payment ts_tipo_spesa: type: string description: >- Can be [ 'TK', 'FC', 'FV', 'SV', 'SP', 'AD', 'AS', 'SR', 'CT', 'PI', 'IC', 'AA' ]. Refer to the technical specifications to learn more. ts_opposizione: type: boolean description: Issued document ts "opposizione" ts_status: type: integer description: Issued document ts status ts_file_id: type: string description: Issued document ts file id ts_sent_date: type: string format: date description: Issued document ts sent date ts_full_amount: type: boolean description: Issued document ts total amount imported_by: type: string description: Issued document imported by software seen_date: type: string description: Issued document seen date format: date next_due_date: type: string description: Issued document date of the next not paid payment format: date url: type: string description: |- [Temporary] [Read Only] Issued document url of the document PDF file dn_url: type: string description: >- [Temporary] [Read Only] Issued document url of the attached delivery note PDF file ai_url: type: string description: |- [Temporary] [Read Only] Issued document url of the accompanying invoice PDF file attachment_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached file readOnly: true attachment_token: type: string description: >- [Write Only] Issued document attachment token returned by POST /issued_documents/attachment writeOnly: true ei_raw: type: object description: Issued document advanced raw attributes for e-invoices ei_status: type: string description: | [Read only] Status of the e-invoice. * **attempt** - We are trying to send the invoice, please wait up to 2 hours * **missing** - The invoice is missing * **not_sent** - The invoice has yet to be sent * **sent** - The invoice was sent * **pending** - The checks for the digital signature and sending are in progress * **processing** - The SDI is delivering the invoice to the customer * **error** - An error occurred while handling the invoice, please try to resend it or contact support * **discarded** - The invoice has been rejected by the SDI, so it must be corrected and re-sent * **not_delivered** - The SDI was unable to deliver the invoice * **accepted** - The customer accepted the invoice * **rejected** - The customer rejected the invoice, so it must be corrected * **no_response** - A response has not yet been received whithin the deadline, contact the customer to ascertain the status of the invoice * **manual_accepted** - The customer accepted the invoice * **manual_rejected** - The customer rejected the invoice enum: - attempt - missing - not_sent - sent - pending - processing - error - discarded - not_delivered - accepted - rejected - no_response - manual_accepted - manual_rejected locked: type: boolean description: Issued Document can't be edited created_at: type: string description: Issued document creation date updated_at: type: string description: Issued document last update date options: title: IssuedDocumentOptions type: object properties: fix_payments: type: boolean description: >- Fixes your last payment amount to match your document total create_from: type: array description: Original documents ids [only for join/transform] items: type: string transform: type: boolean description: Tranform a document [only for transform] keep_copy: type: boolean description: Keep original document [only for transform] join_type: type: string description: Join type [only for join] examples: example-1: value: data: type: receipt numeration: rec123 subject: '' visible_subject: '' amount_net: 68.18 amount_vat: 6.82 amount_due_discount: 0 entity: id: 54321 name: Mary Red S.r.L. vat_number: IT05432181211 tax_code: IT05432181211 address_street: Via Italia, 66 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia certified_email: mary@pec.red.com ei_code: ABCXCR1 date: '2021-08-20' number: 1 next_due_date: '2021-12-31' attachment_token: ypbqqe4u8w8bdabcd5fd5b1a items_list: - product_id: 333 code: SG3 name: Soggiorno measure: '' net_price: 68.18182 category: '' id: 277875565 gross_price: 75 apply_withholding_taxes: true discount: 0 discount_highlight: false in_dn: false qty: 1 vat: id: 3 value: 10 description: '' stock: true description: '' not_taxable: false payments_list: - amount: 75 due_date: '2020-08-23' id: 444 payment_terms: days: 0 type: standard status: not_paid description: The modified document tags: - Issued Documents delete: summary: Delete Issued Document operationId: deleteIssuedDocument responses: '200': description: Document removed '401': description: Unauthorized '404': description: Not Found description: Deletes the specified document. security: - OAuth2AuthenticationCodeFlow: - issued_documents.invoices:a - issued_documents.credit_notes:a - issued_documents.receipts:a - issued_documents.orders:a - issued_documents.quotes:a - issued_documents.proformas:a - issued_documents.delivery_notes:a - ManualAuth: [] parameters: [] tags: - Issued Documents /c/{company_id}/issued_documents/totals: parameters: - $ref: '#/components/parameters/company_id' post: summary: Get New Issued Document Totals operationId: getNewIssuedDocumentTotals responses: '200': $ref: '#/components/responses/GetNewIssuedDocumentTotalsResponse' '401': description: Unauthorized description: Returns the totals for a new document. tags: - Issued Documents security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: GetNewIssuedDocumentTotalsRequest type: object properties: data: title: IssuedDocument type: object properties: id: type: integer description: Issued document id entity: title: Entity type: object properties: id: type: integer description: Entity id code: type: string example: '123' description: Entity code name: type: string example: Rossi S.r.l. description: Entity name type: title: EntityType type: string default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name last_name: type: string description: Entity last name contact_person: type: string description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code address_street: type: string example: Via dei tigli, 12 description: Entitity address street address_postal_code: type: string example: '24010' description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city address_province: type: string example: BG description: Entity address province address_extra: type: string description: Entity address extra info country: type: string example: Italia description: Entity country default: Italia country_iso: type: string example: Italia description: Entity country iso code email: type: string example: mario.rossi@example.it description: Entity email certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email phone: type: string description: Entity phone fax: type: string description: Entity fax notes: type: string description: Entity extra default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms default_vat: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 maximum: 100 minimum: 0 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true default: true is_disabled: type: boolean description: Is the vat type disabled description: |- [Only for client] Client default vat. required: - value default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method description: |- [Only for client] Client default payment method required: - name bank_name: type: string description: |- [Only for client] Client bank name bank_iban: type: string description: |- [Only for client] Client bank iban bank_swift_code: type: string description: |- [Only for client] Client bank swift code shipping_address: type: string description: |- [Only for client] Client Shipping address e_invoice: type: boolean description: |- [Only for client] Use e-invoices. default: false ei_code: type: string description: |- [Only for client] E-invoices code. has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date created_at: type: string description: Entity creation date updated_at: type: string description: Entity last update date required: - name type: type: string default: invoice enum: - invoice - quote - proforma - receipt - delivery_note - credit_note - order - work_report - supplier_order - self_own_invoice - self_supplier_invoice description: Issued document type number: type: integer description: |- Issued document number [If not specified, next number is used] example: 1 numeration: type: string description: |- Issued document numeration [Not available if type=delivery_note] example: /A date: type: string description: |- Issued document date [defaults to today's date] format: date year: type: integer description: Issued document year currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR symbol: type: string description: Currency symbol example: € exchange_rate: type: string description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code language: type: object title: Language properties: code: type: string description: Language code name: type: string description: Language extended name required: - code - name subject: type: string description: Issued document subject visible_subject: type: string description: Issued document visible subject rc_center: type: string description: >- Issued document revenue center [or cost center if type=supplier_order]. notes: type: string description: Issued document extra notes rivalsa: type: number description: Issued document "Rivalsa INPS" percentual value maximum: 100 minimum: 0 cassa: type: number description: Issued document "Cassa previdenziale" percentual value maximum: 100 minimum: 0 amount_cassa: type: number description: |- [Read Only] Issued document cassa amount. readOnly: true cassa_taxable: type: number description: Issued document cassa taxable percentage minimum: 0 maximum: 100 amount_cassa_taxable: type: number description: |- [Can be set only if cassa_taxable is NULL] Issued document cassa taxable amount cassa2: type: number description: Issued document "Cassa previdenziale 2" percentual value maximum: 100 minimum: 0 amount_cassa2: type: number description: |- [Read Only] Issued document cassa2 amount readOnly: true cassa2_taxable: type: number description: Issued document cassa2 taxable percentage minimum: 0 maximum: 100 amount_cassa2_taxable: type: number description: |- [Can be set only if cassa2_taxable is NULL] Issued document cassa2 taxable amount global_cassa_taxable: type: number description: Issued document global cassa taxable percentage minimum: 0 maximum: 100 amount_global_cassa_taxable: type: number description: |- [Can be set only if global_cassa_taxable is NULL] Issued document global cassa taxable amount withholding_tax: type: number description: >- Issued document withholding tax (ritenuta d'acconto) percentual value maximum: 100 minimum: 0 withholding_tax_taxable: type: number description: >- Issued document withholding tax taxable (imponibile) percentual value maximum: 100 minimum: 0 other_withholding_tax: type: number description: >- Issued document other withholding tax (altra ritenuta) percentual value maximum: 100 minimum: 0 stamp_duty: type: number description: |- Issued document stamp duty value [0 if not present] payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method required: - name use_split_payment: type: boolean description: Issued document uses split payment default: false use_gross_prices: type: boolean description: Issued document uses gross prices default: false e_invoice: type: boolean description: Issued document is an e-invoice. default: false ei_data: type: object description: |- Issued document e-invoice data [Only if e_invoice=true] properties: vat_kind: title: VatKind type: string description: Vat kind [esigibilità IVA] default: null enum: - null - I - D - S original_document_type: title: OriginalDocumentType type: string description: Issued document original document type default: ordine enum: - ordine - contratto - convenzione od_number: type: string description: E-invoice original document number od_date: type: string description: E-invoice original document date format: date cig: type: string description: E-invoice CIG cup: type: string description: E-invoice CUP payment_method: type: string description: >- E-invoice payment method [required for e-invoices] (see [here](https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.2/Rappresentazione_Tabellare_FattOrdinaria_V1.2.2.pdf) for the accepted values of ModalitaPagamento) bank_name: type: string description: E-invoice bank name bank_iban: type: string description: E-invoice bank IBAN bank_beneficiary: type: string description: E-invoice bank beneficiary invoice_number: type: string description: E-invoice invoice number invoice_date: type: string format: date description: E-invoice invoice date ei_cassa_type: type: string description: E-invoice cassa type ei_cassa2_type: type: string description: E-invoice cassa2 type ei_withholding_tax_causal: type: string description: E-invoice withholding tax causal ei_other_withholding_tax_type: type: string description: E-invoice other withholding tax type ei_other_withholding_tax_causal: type: string description: E-invoice other withholding tax causal items_list: type: array items: title: IssuedDocumentItemsListItem type: object properties: id: type: integer description: Issued document item id nullable: true product_id: type: integer nullable: true description: Issued document item product id example: 1234 code: type: string description: Issued document item product code example: '239874892374982' nullable: true name: type: string description: Issued document item product name example: Water bottle nullable: true category: type: string description: Issued document item product category nullable: true description: type: string description: Issued document product description nullable: true qty: type: number description: Issued document item quantity nullable: true measure: type: string description: Issued document item measure nullable: true net_price: type: number description: Issued document item net price example: 1.23 nullable: true gross_price: type: number nullable: true example: 1.45 description: Issued document item gross price vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true not_taxable: type: boolean nullable: true description: Issued document item is not taxable apply_withholding_taxes: type: boolean description: >- Issued document item apply withholding taxes, rivalsa and cassa nullable: true discount: type: number description: Issued document item discount percentual value nullable: true discount_highlight: type: boolean nullable: true description: Issued document item highlight discount in_dn: type: boolean nullable: true description: Issued document item add in delivery note stock: type: boolean nullable: true description: Issued document item move stock ei_raw: type: object description: >- Issued document advanced raw attributes for e-invoices nullable: true payments_list: type: array items: title: IssuedDocumentPaymentsListItem type: object properties: id: type: integer description: Issued document payment item id nullable: true due_date: type: string description: Issued document payment due date format: date example: '2018-04-03' nullable: true amount: type: number description: Issued document payment amount example: 1.45 nullable: true status: title: IssuedDocumentStatus type: string description: Issued document status default: not_paid enum: - not_paid - paid - reversed payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true paid_date: type: string description: |- Issued document payment date [Only if status is paid] format: date example: '2018-04-03' nullable: true ei_raw: type: object nullable: true description: >- Issued document payment advanced raw attributes for e-invoices payment_terms: type: object properties: days: type: integer nullable: true description: >- Issued document payment number of days by which the payment must be made type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 name: type: string example: Light Smoke description: Template name type: type: string description: Template type delivery_note_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 name: type: string example: Light Smoke description: Template name type: type: string description: Template type acc_inv_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 name: type: string example: Light Smoke description: Template name type: type: string description: Template type h_margins: type: integer description: Issued document PDF horizontal margins v_margins: type: integer description: Issued document PDF vertical margins show_payments: type: boolean description: >- Show the expiration dates of the payments on the document show_payment_method: type: boolean description: Show the payment method details on the document show_totals: title: ShowTotalsMode type: string description: Show totals mode default: all enum: - none - nets - all show_notification_button: type: boolean description: Show notification button in the PDF default: false show_tspay_button: type: boolean description: Show ts pay button in the PDF delivery_note: type: boolean description: Issued document has delivery note accompanying_invoice: type: boolean description: Issued document has an accompanying invoice default: false dn_number: type: integer description: Issued document attached delivery note number dn_date: type: string description: Issued document attached delivery note date format: date dn_ai_packages_number: type: string description: >- Issued document attached delivery note number of packages dn_ai_weight: type: string description: Issued document attached delivery note package weight dn_ai_causal: type: string description: Issued document attached delivery note causal dn_ai_destination: type: string description: Issued document attached delivery note destination dn_ai_transporter: type: string description: Issued document attached delivery note transporter dn_ai_notes: type: string description: Issued document attached delivery note notes is_marked: type: boolean description: Issued document is marked amount_net: type: number description: |- [Read only] Issued document total net amount readOnly: true amount_vat: type: number description: |- [Read Only] Issued document total vat amount readOnly: true amount_gross: type: number description: |- [Read Only] Issued document total gross amount readOnly: true amount_due_discount: type: number description: Issued document amount due discount amount_rivalsa: type: number description: |- [Read Only] Issued document rivalsa amount readOnly: true amount_rivalsa_taxable: type: number description: Issued document taxable rivalsa amount amount_withholding_tax: type: number description: >- [Read Only] Issued document withholding tax amount (ritenuta d'acconto). readOnly: true amount_withholding_tax_taxable: type: number description: Issued document taxable withholding tax amount amount_other_withholding_tax: type: number description: >- [Read Only] Issued document other withholding tax amount (altra ritenuta) readOnly: true amount_other_withholding_tax_taxable: type: number description: Issued document taxable other withholding tax amount amount_enasarco_taxable: type: number description: Issued document taxable enasarco amount extra_data: type: object description: >- Issued document extra data [TS fields follow the technical specifications provided by "Sistema Tessera Sanitaria"] properties: multifatture_sent: type: integer ts_communication: type: boolean description: Send issued document to "Sistema Tessera Sanitaria" ts_flag_tipo_spesa: type: number description: >- Issued document ts "tipo spesa" [TK, FC, FV, SV,SP, AD, AS, ECG, SR] ts_pagamento_tracciato: type: boolean description: Issued document ts traced payment ts_tipo_spesa: type: string description: >- Can be [ 'TK', 'FC', 'FV', 'SV', 'SP', 'AD', 'AS', 'SR', 'CT', 'PI', 'IC', 'AA' ]. Refer to the technical specifications to learn more. ts_opposizione: type: boolean description: Issued document ts "opposizione" ts_status: type: integer description: Issued document ts status ts_file_id: type: string description: Issued document ts file id ts_sent_date: type: string format: date description: Issued document ts sent date ts_full_amount: type: boolean description: Issued document ts total amount imported_by: type: string description: Issued document imported by software seen_date: type: string description: Issued document seen date format: date next_due_date: type: string description: Issued document date of the next not paid payment format: date url: type: string description: |- [Temporary] [Read Only] Issued document url of the document PDF file dn_url: type: string description: >- [Temporary] [Read Only] Issued document url of the attached delivery note PDF file ai_url: type: string description: |- [Temporary] [Read Only] Issued document url of the accompanying invoice PDF file attachment_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached file readOnly: true attachment_token: type: string description: >- [Write Only] Issued document attachment token returned by POST /issued_documents/attachment writeOnly: true ei_raw: type: object description: Issued document advanced raw attributes for e-invoices ei_status: type: string description: | [Read only] Status of the e-invoice. * **attempt** - We are trying to send the invoice, please wait up to 2 hours * **missing** - The invoice is missing * **not_sent** - The invoice has yet to be sent * **sent** - The invoice was sent * **pending** - The checks for the digital signature and sending are in progress * **processing** - The SDI is delivering the invoice to the customer * **error** - An error occurred while handling the invoice, please try to resend it or contact support * **discarded** - The invoice has been rejected by the SDI, so it must be corrected and re-sent * **not_delivered** - The SDI was unable to deliver the invoice * **accepted** - The customer accepted the invoice * **rejected** - The customer rejected the invoice, so it must be corrected * **no_response** - A response has not yet been received whithin the deadline, contact the customer to ascertain the status of the invoice * **manual_accepted** - The customer accepted the invoice * **manual_rejected** - The customer rejected the invoice enum: - attempt - missing - not_sent - sent - pending - processing - error - discarded - not_delivered - accepted - rejected - no_response - manual_accepted - manual_rejected locked: type: boolean description: Issued Document can't be edited created_at: type: string description: Issued document creation date updated_at: type: string description: Issued document last update date examples: example-1: value: data: id: 12345 type: receipt year: 2021 numeration: rec123 subject: '' visible_subject: '' rc_center: '' stamp_duty: 0 use_gross_prices: false delivery_note: false accompanying_invoice: false amount_net: 68.18 amount_vat: 6.82 amount_due_discount: 0 amount_rivalsa: 0 amount_cassa: 0 amount_withholding_tax: 0 amount_other_withholding_tax: 0 h_margins: 15 v_margins: 16 show_payment_method: false show_payments: true show_totals: all show_notification_button: false is_marked: false created_at: '2021-08-13 09:30:20' updated_at: '2021-08-23 05:34:20' entity: id: 54321 name: Mary Red S.r.L. vat_number: IT05432181211 tax_code: IT05432181211 address_street: Via Italia, 66 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia certified_email: mary@pec.red.com ei_code: ABCXCR1 date: '2021-08-20' number: 1 currency: id: EUR exchange_rate: '1.00000' symbol: € language: code: it name: Italiano notes: '' rivalsa: 0 cassa: 0 withholding_tax: 0 withholding_tax_taxable: 100 other_withholding_tax: 0 payment_method: id: 4 name: Credit card use_split_payment: false items_list: - product_id: 5432 code: SG3 name: Soggiorno measure: '' net_price: 68.18182 category: '' id: 277876033 apply_withholding_taxes: true discount: 0 discount_highlight: false in_dn: false qty: 1 vat: id: 3 value: 10 description: '' stock: false description: '' not_taxable: false payments_list: - amount: 75 due_date: '2020-08-23' id: 69078013 payment_terms: days: 0 type: standard status: not_paid attachment_url: kdijrnf893hnwkfk45f50f.pdf next_due_date: '2020-08-23' template: id: 2821 name: Light Smoke url: y12h45rn9yf2mse0p43t7ec90vr.pdf /c/{company_id}/issued_documents/{document_id}/totals: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' post: summary: Get Existing Issued Document Totals operationId: getExistingIssuedDocumentTotals responses: '200': $ref: '#/components/responses/GetExistingIssuedDocumentTotalsResponse' '401': description: Unauthorized '404': description: Not Found tags: - Issued Documents description: Returns the totals for a specified document. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: GetExistingIssuedDocumentTotalsRequest type: object properties: data: title: IssuedDocument type: object properties: id: type: integer description: Issued document id entity: title: Entity type: object properties: id: type: integer description: Entity id code: type: string example: '123' description: Entity code name: type: string example: Rossi S.r.l. description: Entity name type: title: EntityType type: string default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name last_name: type: string description: Entity last name contact_person: type: string description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code address_street: type: string example: Via dei tigli, 12 description: Entitity address street address_postal_code: type: string example: '24010' description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city address_province: type: string example: BG description: Entity address province address_extra: type: string description: Entity address extra info country: type: string example: Italia description: Entity country default: Italia country_iso: type: string example: Italia description: Entity country iso code email: type: string example: mario.rossi@example.it description: Entity email certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email phone: type: string description: Entity phone fax: type: string description: Entity fax notes: type: string description: Entity extra default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms default_vat: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 maximum: 100 minimum: 0 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true default: true is_disabled: type: boolean description: Is the vat type disabled description: |- [Only for client] Client default vat. required: - value default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method description: |- [Only for client] Client default payment method required: - name bank_name: type: string description: |- [Only for client] Client bank name bank_iban: type: string description: |- [Only for client] Client bank iban bank_swift_code: type: string description: |- [Only for client] Client bank swift code shipping_address: type: string description: |- [Only for client] Client Shipping address e_invoice: type: boolean description: |- [Only for client] Use e-invoices. default: false ei_code: type: string description: |- [Only for client] E-invoices code. has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date created_at: type: string description: Entity creation date updated_at: type: string description: Entity last update date required: - name type: type: string default: invoice enum: - invoice - quote - proforma - receipt - delivery_note - credit_note - order - work_report - supplier_order - self_own_invoice - self_supplier_invoice description: Issued document type number: type: integer description: |- Issued document number [If not specified, next number is used] example: 1 numeration: type: string description: |- Issued document numeration [Not available if type=delivery_note] example: /A date: type: string description: |- Issued document date [defaults to today's date] format: date year: type: integer description: Issued document year currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR symbol: type: string description: Currency symbol example: € exchange_rate: type: string description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code language: type: object title: Language properties: code: type: string description: Language code name: type: string description: Language extended name required: - code - name subject: type: string description: Issued document subject visible_subject: type: string description: Issued document visible subject rc_center: type: string description: >- Issued document revenue center [or cost center if type=supplier_order]. notes: type: string description: Issued document extra notes rivalsa: type: number description: Issued document "Rivalsa INPS" percentual value maximum: 100 minimum: 0 cassa: type: number description: Issued document "Cassa previdenziale" percentual value maximum: 100 minimum: 0 amount_cassa: type: number description: |- [Read Only] Issued document cassa amount. readOnly: true cassa_taxable: type: number description: Issued document cassa taxable percentage minimum: 0 maximum: 100 amount_cassa_taxable: type: number description: |- [Can be set only if cassa_taxable is NULL] Issued document cassa taxable amount cassa2: type: number description: Issued document "Cassa previdenziale 2" percentual value maximum: 100 minimum: 0 amount_cassa2: type: number description: |- [Read Only] Issued document cassa2 amount readOnly: true cassa2_taxable: type: number description: Issued document cassa2 taxable percentage minimum: 0 maximum: 100 amount_cassa2_taxable: type: number description: |- [Can be set only if cassa2_taxable is NULL] Issued document cassa2 taxable amount global_cassa_taxable: type: number description: Issued document global cassa taxable percentage minimum: 0 maximum: 100 amount_global_cassa_taxable: type: number description: |- [Can be set only if global_cassa_taxable is NULL] Issued document global cassa taxable amount withholding_tax: type: number description: >- Issued document withholding tax (ritenuta d'acconto) percentual value maximum: 100 minimum: 0 withholding_tax_taxable: type: number description: >- Issued document withholding tax taxable (imponibile) percentual value maximum: 100 minimum: 0 other_withholding_tax: type: number description: >- Issued document other withholding tax (altra ritenuta) percentual value maximum: 100 minimum: 0 stamp_duty: type: number description: |- Issued document stamp duty value [0 if not present] payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method required: - name use_split_payment: type: boolean description: Issued document uses split payment default: false use_gross_prices: type: boolean description: Issued document uses gross prices default: false e_invoice: type: boolean description: Issued document is an e-invoice. default: false ei_data: type: object description: |- Issued document e-invoice data [Only if e_invoice=true] properties: vat_kind: title: VatKind type: string description: Vat kind [esigibilità IVA] default: null enum: - null - I - D - S original_document_type: title: OriginalDocumentType type: string description: Issued document original document type default: ordine enum: - ordine - contratto - convenzione od_number: type: string description: E-invoice original document number od_date: type: string description: E-invoice original document date format: date cig: type: string description: E-invoice CIG cup: type: string description: E-invoice CUP payment_method: type: string description: >- E-invoice payment method [required for e-invoices] (see [here](https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.2/Rappresentazione_Tabellare_FattOrdinaria_V1.2.2.pdf) for the accepted values of ModalitaPagamento) bank_name: type: string description: E-invoice bank name bank_iban: type: string description: E-invoice bank IBAN bank_beneficiary: type: string description: E-invoice bank beneficiary invoice_number: type: string description: E-invoice invoice number invoice_date: type: string format: date description: E-invoice invoice date ei_cassa_type: type: string description: E-invoice cassa type ei_cassa2_type: type: string description: E-invoice cassa2 type ei_withholding_tax_causal: type: string description: E-invoice withholding tax causal ei_other_withholding_tax_type: type: string description: E-invoice other withholding tax type ei_other_withholding_tax_causal: type: string description: E-invoice other withholding tax causal items_list: type: array items: title: IssuedDocumentItemsListItem type: object properties: id: type: integer description: Issued document item id nullable: true product_id: type: integer nullable: true description: Issued document item product id example: 1234 code: type: string description: Issued document item product code example: '239874892374982' nullable: true name: type: string description: Issued document item product name example: Water bottle nullable: true category: type: string description: Issued document item product category nullable: true description: type: string description: Issued document product description nullable: true qty: type: number description: Issued document item quantity nullable: true measure: type: string description: Issued document item measure nullable: true net_price: type: number description: Issued document item net price example: 1.23 nullable: true gross_price: type: number nullable: true example: 1.45 description: Issued document item gross price vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true not_taxable: type: boolean nullable: true description: Issued document item is not taxable apply_withholding_taxes: type: boolean description: >- Issued document item apply withholding taxes, rivalsa and cassa nullable: true discount: type: number description: Issued document item discount percentual value nullable: true discount_highlight: type: boolean nullable: true description: Issued document item highlight discount in_dn: type: boolean nullable: true description: Issued document item add in delivery note stock: type: boolean nullable: true description: Issued document item move stock ei_raw: type: object description: >- Issued document advanced raw attributes for e-invoices nullable: true payments_list: type: array items: title: IssuedDocumentPaymentsListItem type: object properties: id: type: integer description: Issued document payment item id nullable: true due_date: type: string description: Issued document payment due date format: date example: '2018-04-03' nullable: true amount: type: number description: Issued document payment amount example: 1.45 nullable: true status: title: IssuedDocumentStatus type: string description: Issued document status default: not_paid enum: - not_paid - paid - reversed payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true paid_date: type: string description: |- Issued document payment date [Only if status is paid] format: date example: '2018-04-03' nullable: true ei_raw: type: object nullable: true description: >- Issued document payment advanced raw attributes for e-invoices payment_terms: type: object properties: days: type: integer nullable: true description: >- Issued document payment number of days by which the payment must be made type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 name: type: string example: Light Smoke description: Template name type: type: string description: Template type delivery_note_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 name: type: string example: Light Smoke description: Template name type: type: string description: Template type acc_inv_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 name: type: string example: Light Smoke description: Template name type: type: string description: Template type h_margins: type: integer description: Issued document PDF horizontal margins v_margins: type: integer description: Issued document PDF vertical margins show_payments: type: boolean description: >- Show the expiration dates of the payments on the document show_payment_method: type: boolean description: Show the payment method details on the document show_totals: title: ShowTotalsMode type: string description: Show totals mode default: all enum: - none - nets - all show_notification_button: type: boolean description: Show notification button in the PDF default: false show_tspay_button: type: boolean description: Show ts pay button in the PDF delivery_note: type: boolean description: Issued document has delivery note accompanying_invoice: type: boolean description: Issued document has an accompanying invoice default: false dn_number: type: integer description: Issued document attached delivery note number dn_date: type: string description: Issued document attached delivery note date format: date dn_ai_packages_number: type: string description: >- Issued document attached delivery note number of packages dn_ai_weight: type: string description: Issued document attached delivery note package weight dn_ai_causal: type: string description: Issued document attached delivery note causal dn_ai_destination: type: string description: Issued document attached delivery note destination dn_ai_transporter: type: string description: Issued document attached delivery note transporter dn_ai_notes: type: string description: Issued document attached delivery note notes is_marked: type: boolean description: Issued document is marked amount_net: type: number description: |- [Read only] Issued document total net amount readOnly: true amount_vat: type: number description: |- [Read Only] Issued document total vat amount readOnly: true amount_gross: type: number description: |- [Read Only] Issued document total gross amount readOnly: true amount_due_discount: type: number description: Issued document amount due discount amount_rivalsa: type: number description: |- [Read Only] Issued document rivalsa amount readOnly: true amount_rivalsa_taxable: type: number description: Issued document taxable rivalsa amount amount_withholding_tax: type: number description: >- [Read Only] Issued document withholding tax amount (ritenuta d'acconto). readOnly: true amount_withholding_tax_taxable: type: number description: Issued document taxable withholding tax amount amount_other_withholding_tax: type: number description: >- [Read Only] Issued document other withholding tax amount (altra ritenuta) readOnly: true amount_other_withholding_tax_taxable: type: number description: Issued document taxable other withholding tax amount amount_enasarco_taxable: type: number description: Issued document taxable enasarco amount extra_data: type: object description: >- Issued document extra data [TS fields follow the technical specifications provided by "Sistema Tessera Sanitaria"] properties: multifatture_sent: type: integer ts_communication: type: boolean description: Send issued document to "Sistema Tessera Sanitaria" ts_flag_tipo_spesa: type: number description: >- Issued document ts "tipo spesa" [TK, FC, FV, SV,SP, AD, AS, ECG, SR] ts_pagamento_tracciato: type: boolean description: Issued document ts traced payment ts_tipo_spesa: type: string description: >- Can be [ 'TK', 'FC', 'FV', 'SV', 'SP', 'AD', 'AS', 'SR', 'CT', 'PI', 'IC', 'AA' ]. Refer to the technical specifications to learn more. ts_opposizione: type: boolean description: Issued document ts "opposizione" ts_status: type: integer description: Issued document ts status ts_file_id: type: string description: Issued document ts file id ts_sent_date: type: string format: date description: Issued document ts sent date ts_full_amount: type: boolean description: Issued document ts total amount imported_by: type: string description: Issued document imported by software seen_date: type: string description: Issued document seen date format: date next_due_date: type: string description: Issued document date of the next not paid payment format: date url: type: string description: |- [Temporary] [Read Only] Issued document url of the document PDF file dn_url: type: string description: >- [Temporary] [Read Only] Issued document url of the attached delivery note PDF file ai_url: type: string description: |- [Temporary] [Read Only] Issued document url of the accompanying invoice PDF file attachment_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached file readOnly: true attachment_token: type: string description: >- [Write Only] Issued document attachment token returned by POST /issued_documents/attachment writeOnly: true ei_raw: type: object description: Issued document advanced raw attributes for e-invoices ei_status: type: string description: | [Read only] Status of the e-invoice. * **attempt** - We are trying to send the invoice, please wait up to 2 hours * **missing** - The invoice is missing * **not_sent** - The invoice has yet to be sent * **sent** - The invoice was sent * **pending** - The checks for the digital signature and sending are in progress * **processing** - The SDI is delivering the invoice to the customer * **error** - An error occurred while handling the invoice, please try to resend it or contact support * **discarded** - The invoice has been rejected by the SDI, so it must be corrected and re-sent * **not_delivered** - The SDI was unable to deliver the invoice * **accepted** - The customer accepted the invoice * **rejected** - The customer rejected the invoice, so it must be corrected * **no_response** - A response has not yet been received whithin the deadline, contact the customer to ascertain the status of the invoice * **manual_accepted** - The customer accepted the invoice * **manual_rejected** - The customer rejected the invoice enum: - attempt - missing - not_sent - sent - pending - processing - error - discarded - not_delivered - accepted - rejected - no_response - manual_accepted - manual_rejected locked: type: boolean description: Issued Document can't be edited created_at: type: string description: Issued document creation date updated_at: type: string description: Issued document last update date examples: example-1: value: data: rivalsa: 20 /c/{company_id}/issued_documents/attachment: parameters: - $ref: '#/components/parameters/company_id' post: summary: Upload Issued Document Attachment operationId: uploadIssuedDocumentAttachment responses: '200': $ref: '#/components/responses/UploadIssuedDocumentAttachmentResponse' '401': description: Unauthorized tags: - Issued Documents description: >- Uploads an attachment destined to an issued document. The actual association between the document and the attachment must be implemented separately, using the returned token. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] requestBody: content: multipart/form-data: schema: title: Attachment type: object properties: filename: type: string description: Attachment file name example: attachment.pdf attachment: type: string description: >- Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx] format: binary description: '' examples: example-1: value: filename: ricevuta_maryRedSRL attachment: ricevuta_20_08_2020.pdf description: Attachment. /c/{company_id}/issued_documents/{document_id}/attachment: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' delete: summary: Delete Issued Document Attachment operationId: deleteIssuedDocumentAttachment responses: '200': description: File removed. '401': description: Unauthorized '404': description: Not Found description: Removes the attachment of the specified document. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] tags: - Issued Documents /c/{company_id}/issued_documents/info: parameters: - $ref: '#/components/parameters/company_id' get: summary: Get Issued Document Pre-Create Info tags: - Issued Documents responses: '200': $ref: '#/components/responses/GetIssuedDocumentPreCreateInfoResponse' operationId: getIssuedDocumentPreCreateInfo description: Retrieves the information useful while creating a new document. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: - $ref: '#/components/parameters/issued_document_type' /c/{company_id}/issued_documents/{document_id}/email: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' get: summary: Get Email Data tags: - Issued Documents responses: '200': $ref: '#/components/responses/GetEmailDataResponse' operationId: getEmailData description: Gets the pre-compiled email details. security: - OAuth2AuthenticationCodeFlow: - issued_documents.invoices:r - issued_documents.credit_notes:r - issued_documents.receipts:r - issued_documents.orders:r - issued_documents.quotes:r - issued_documents.proformas:r - issued_documents.delivery_notes:r - ManualAuth: [] parameters: [] post: summary: Schedule Email operationId: scheduleEmail responses: '200': description: OK '401': description: Unauthorized '404': description: Not Found description: Schedules the sending of a document by email. security: - OAuth2AuthenticationCodeFlow: - issued_documents.invoices:r - issued_documents.credit_notes:r - issued_documents.receipts:r - issued_documents.orders:r - issued_documents.quotes:r - issued_documents.proformas:r - issued_documents.delivery_notes:r - ManualAuth: [] tags: - Issued Documents parameters: [] requestBody: content: application/json: schema: title: ScheduleEmailRequest type: object properties: data: type: object title: EmailSchedule properties: sender_id: type: integer description: >- Email sender id [required if **sender_email** is not specified] sender_email: type: string description: >- Email sender address [required if **sender_id** is not specified] recipient_email: type: string description: Email recipient emails [comma separated] subject: type: string description: Email subject body: type: string description: Email body [HTML Escaped] [max size 50KiB] include: type: object properties: document: type: boolean description: Include a button to view the document delivery_note: type: boolean description: Include a button to view the delivery note attachment: type: boolean description: Include a button to view the attachment accompanying_invoice: type: boolean description: Include a button to view the accompanying invoice required: - document - delivery_note - attachment - accompanying_invoice attach_pdf: type: boolean description: Attach the pdf of the document send_copy: type: boolean description: >- Send a copy of the email to the **cc_email** specified by **Get email data** required: - recipient_email - subject - body - include - attach_pdf - send_copy description: '' examples: example-1: value: data: sender_email: mariorossi@fattureincloud.it recipient_email: mary.red@example.com subject: Nostra pro forma nr. 1 body: >- Gentile Mario Rossi,
per vedere la nostra pro forma di o per scaricarne una copia in versione PDF prema sul bottone sottostante.

{{allegati}}

Cordiali saluti,
Mario Rossi include: document: false delivery_note: false attachment: false accompanying_invoice: false attach_pdf: true send_copy: false description: Email Schedule /c/{company_id}/issued_documents/{document_id}/e_invoice/send: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' post: summary: Send E-Invoice operationId: sendEInvoice responses: '200': $ref: '#/components/responses/SendEInvoiceResponse' '401': description: Unauthorized '404': description: Not Found description: Sends the e-invoice to SDI. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: SendEInvoiceRequest type: object properties: data: type: object properties: cassa_type: type: string description: >- Value of TipoCassa used (optional, override the company default value). withholding_tax_causal: type: string description: >- Value of CausalePagamento used (optional, override the company default value). options: type: object properties: dry_run: type: boolean description: >- If set to true the e-invoice will not be sent to the SDI. examples: example-1: value: data: withholding_tax_causal: causale description: '' tags: - Issued e-invoices /c/{company_id}/issued_documents/{document_id}/e_invoice/xml_verify: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' get: summary: Verify E-Invoice XML tags: - Issued e-invoices responses: '200': $ref: '#/components/responses/VerifyEInvoiceXmlResponse' '401': description: Unauthorized '404': description: Not Found '422': $ref: '#/components/responses/VerifyEInvoiceXmlErrorResponse' operationId: verifyEInvoiceXml description: >- Verifies the e-invoice XML format. Checks if all of the mandatory fields are filled and compliant to the right format. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /c/{company_id}/issued_documents/{document_id}/e_invoice/xml: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' get: summary: Get E-Invoice XML tags: - Issued e-invoices responses: '200': $ref: '#/components/responses/GetEInvoiceXmlResponse' '401': description: Unauthorized '404': description: Not Found operationId: getEInvoiceXml description: Downloads the e-invoice in XML format. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: - $ref: '#/components/parameters/include_attachment' /c/{company_id}/issued_documents/{document_id}/e_invoice/error_reason: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' get: summary: Get E-Invoice Rejection Reason tags: - Issued e-invoices responses: '200': $ref: '#/components/responses/GetEInvoiceRejectionReasonResponse' operationId: getEInvoiceRejectionReason description: Get e-invoice rejection reason security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] /c/{company_id}/received_documents: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Received Documents tags: - Received Documents responses: '200': $ref: '#/components/responses/ListReceivedDocumentsResponse' '401': description: Unauthorized operationId: listReceivedDocuments description: Lists the received documents. security: - OAuth2AuthenticationCodeFlow: - received_documents:r - stock:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/received_document_type' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' - $ref: '#/components/parameters/q' post: summary: Create Received Document operationId: createReceivedDocument responses: '200': $ref: '#/components/responses/CreateReceivedDocumentResponse' description: Creates a new document. security: - OAuth2AuthenticationCodeFlow: - received_documents:a - stock:a - ManualAuth: [] tags: - Received Documents parameters: [] requestBody: content: application/json: schema: title: CreateReceivedDocumentRequest type: object description: '' properties: pending_id: type: integer description: >- Pending received document id of the document from which the new document is created. data: type: object title: ReceivedDocument properties: id: type: integer description: Received document id type: title: ReceivedDocumentType type: string default: expense enum: - expense - passive_credit_note - passive_delivery_note description: Received document type entity: title: Entity type: object properties: id: type: integer description: Entity id code: type: string example: '123' description: Entity code name: type: string example: Rossi S.r.l. description: Entity name type: title: EntityType type: string default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name last_name: type: string description: Entity last name contact_person: type: string description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code address_street: type: string example: Via dei tigli, 12 description: Entitity address street address_postal_code: type: string example: '24010' description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city address_province: type: string example: BG description: Entity address province address_extra: type: string description: Entity address extra info country: type: string example: Italia description: Entity country country_iso: type: string example: Italia description: Entity country iso code email: type: string example: mario.rossi@example.it description: Entity email certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email phone: type: string description: Entity phone fax: type: string description: Entity fax notes: type: string description: Entity extra default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms default_vat: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true is_disabled: type: boolean description: Is the vat type disabled description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name bank_iban: type: string description: |- [Only for client] Client bank iban bank_swift_code: type: string description: |- [Only for client] Client bank swift code shipping_address: type: string description: |- [Only for client] Client Shipping address e_invoice: type: boolean description: |- [Only for client] Use e-invoices. ei_code: type: string description: |- [Only for client] E-invoices code. has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date created_at: type: string description: Entity creation date updated_at: type: string description: Entity last update date date: type: string description: Received document date [defaults to today's date] format: date category: type: string description: Received document category description: type: string description: Received document description amount_net: type: number description: Received document total net amount amount_vat: type: number description: Received document total vat amount amount_withholding_tax: type: number description: Received document withholding tax amount amount_other_withholding_tax: type: number description: Received document other withholding tax amount amount_gross: type: number description: |- [Read Only] Received document total gross amount readOnly: true amortization: type: number description: Received document amortization value rc_center: type: string description: Received document revenue center invoice_number: type: string description: Received document invoice number is_marked: type: boolean description: Received document is marked is_detailed: type: boolean description: Received document has items e_invoice: type: boolean description: |- [Read Only] Received document is an e-invoice next_due_date: type: string description: |- [Read Only] Received document date of the next not paid payment format: date readOnly: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR symbol: type: string description: Currency symbol example: € exchange_rate: type: string description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code tax_deductibility: type: number description: Received document tax deducibility percentage maximum: 100 minimum: 0 vat_deductibility: type: number description: Received document vat deducibility percentage maximum: 100 minimum: 0 items_list: type: array items: title: ReceivedDocumentItemsListItem type: object properties: id: type: integer description: Received document item id nullable: true product_id: type: integer description: Received document product id nullable: true code: type: string description: Received document item product code nullable: true name: type: string description: Received document item product name nullable: true measure: type: string description: Received document item measure nullable: true net_price: type: number description: Received document item product net price nullable: true category: type: string description: Received document item product category nullable: true qty: type: number description: Received document item quantity nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true stock: type: number description: >- Received document item product number of items in stock nullable: true payments_list: type: array items: title: ReceivedDocumentPaymentsListItem type: object properties: id: type: integer description: Received document payment id nullable: true amount: type: number description: Received document payment total amount nullable: true due_date: type: string description: Due date format: date nullable: true paid_date: type: string description: Received document payment paid date format: date nullable: true payment_terms: type: object nullable: true properties: days: type: integer description: >- Received document payment number of days by which the payment must be made nullable: true type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type status: type: string description: Received document payment status nullable: true payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Received document url of the attached file readOnly: true attachment_preview_url: type: string description: |- [Temporary] [Read Only] Received document url of the attachment preview readOnly: true auto_calculate: type: boolean description: >- Received document total items amount and total payments amount can differ if this field is set to false attachment_token: type: string description: >- [Write Only] Received document attachment token returned by POST /received_documents/attachment locked: type: boolean description: Received Document can't be edited created_at: type: string description: Received document creation date updated_at: type: string description: Received document last update date required: - entity examples: example-1: value: data: type: expense description: Soggiorno di lavoro amortization: 1 rc_center: '' invoice_number: '' is_marked: false is_detailed: false e_invoice: false entity: id: 111 name: Hotel Rubino Palace date: '2021-08-15' next_due_date: '2021-08-15' currency: id: EUR exchange_rate: '1.00000' symbol: € amount_net: 592 amount_vat: 0 amount_gross: 592 amount_withholding_tax: 0 amount_other_withholding_tax: 0 tax_deductibility: 50 vat_deductibility: 100 payments_list: - amount: 592 due_date: '2021-08-15' paid_date: '2021-08-15' id: 777 payment_terms: days: 0 type: standard status: paid payment_account: id: 222 name: Contanti virtual: false attachment_token: bnopjao8gvydtgnewgiovs74yrfqwefEF description: Document to create /c/{company_id}/received_documents/{document_id}: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' get: summary: Get Received Document tags: - Received Documents responses: '200': $ref: '#/components/responses/GetReceivedDocumentResponse' '401': description: Unauthorized '404': description: Not Found operationId: getReceivedDocument description: Gets the specified document. security: - OAuth2AuthenticationCodeFlow: - received_documents:r - stock:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' put: summary: Modify Received Document operationId: modifyReceivedDocument responses: '200': $ref: '#/components/responses/ModifyReceivedDocumentResponse' '401': description: Unauthorized '404': description: Not Found tags: - Received Documents description: Modifies the specified document. security: - OAuth2AuthenticationCodeFlow: - received_documents:a - stock:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: ModifyReceivedDocumentRequest type: object properties: data: type: object title: ReceivedDocument properties: id: type: integer description: Received document id type: title: ReceivedDocumentType type: string default: expense enum: - expense - passive_credit_note - passive_delivery_note description: Received document type entity: title: Entity type: object properties: id: type: integer description: Entity id code: type: string example: '123' description: Entity code name: type: string example: Rossi S.r.l. description: Entity name type: title: EntityType type: string default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name last_name: type: string description: Entity last name contact_person: type: string description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code address_street: type: string example: Via dei tigli, 12 description: Entitity address street address_postal_code: type: string example: '24010' description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city address_province: type: string example: BG description: Entity address province address_extra: type: string description: Entity address extra info country: type: string example: Italia description: Entity country country_iso: type: string example: Italia description: Entity country iso code email: type: string example: mario.rossi@example.it description: Entity email certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email phone: type: string description: Entity phone fax: type: string description: Entity fax notes: type: string description: Entity extra default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms default_vat: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true is_disabled: type: boolean description: Is the vat type disabled description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name bank_iban: type: string description: |- [Only for client] Client bank iban bank_swift_code: type: string description: |- [Only for client] Client bank swift code shipping_address: type: string description: |- [Only for client] Client Shipping address e_invoice: type: boolean description: |- [Only for client] Use e-invoices. ei_code: type: string description: |- [Only for client] E-invoices code. has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date created_at: type: string description: Entity creation date updated_at: type: string description: Entity last update date date: type: string description: Received document date [defaults to today's date] format: date category: type: string description: Received document category description: type: string description: Received document description amount_net: type: number description: Received document total net amount amount_vat: type: number description: Received document total vat amount amount_withholding_tax: type: number description: Received document withholding tax amount amount_other_withholding_tax: type: number description: Received document other withholding tax amount amount_gross: type: number description: |- [Read Only] Received document total gross amount readOnly: true amortization: type: number description: Received document amortization value rc_center: type: string description: Received document revenue center invoice_number: type: string description: Received document invoice number is_marked: type: boolean description: Received document is marked is_detailed: type: boolean description: Received document has items e_invoice: type: boolean description: |- [Read Only] Received document is an e-invoice next_due_date: type: string description: |- [Read Only] Received document date of the next not paid payment format: date readOnly: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR symbol: type: string description: Currency symbol example: € exchange_rate: type: string description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code tax_deductibility: type: number description: Received document tax deducibility percentage maximum: 100 minimum: 0 vat_deductibility: type: number description: Received document vat deducibility percentage maximum: 100 minimum: 0 items_list: type: array items: title: ReceivedDocumentItemsListItem type: object properties: id: type: integer description: Received document item id nullable: true product_id: type: integer description: Received document product id nullable: true code: type: string description: Received document item product code nullable: true name: type: string description: Received document item product name nullable: true measure: type: string description: Received document item measure nullable: true net_price: type: number description: Received document item product net price nullable: true category: type: string description: Received document item product category nullable: true qty: type: number description: Received document item quantity nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true stock: type: number description: >- Received document item product number of items in stock nullable: true payments_list: type: array items: title: ReceivedDocumentPaymentsListItem type: object properties: id: type: integer description: Received document payment id nullable: true amount: type: number description: Received document payment total amount nullable: true due_date: type: string description: Due date format: date nullable: true paid_date: type: string description: Received document payment paid date format: date nullable: true payment_terms: type: object nullable: true properties: days: type: integer description: >- Received document payment number of days by which the payment must be made nullable: true type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type status: type: string description: Received document payment status nullable: true payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Received document url of the attached file readOnly: true attachment_preview_url: type: string description: |- [Temporary] [Read Only] Received document url of the attachment preview readOnly: true auto_calculate: type: boolean description: >- Received document total items amount and total payments amount can differ if this field is set to false attachment_token: type: string description: >- [Write Only] Received document attachment token returned by POST /received_documents/attachment locked: type: boolean description: Received Document can't be edited created_at: type: string description: Received document creation date updated_at: type: string description: Received document last update date required: - entity description: '' examples: example-1: value: data: type: expense description: Soggiorno di lavoro amortization: 1 rc_center: '' invoice_number: '' is_marked: false is_detailed: false e_invoice: false entity: id: 111 name: Hotel Rubino Palace date: '2021-08-15' next_due_date: '2021-08-15' currency: id: EUR exchange_rate: '1.00000' symbol: € amount_net: 592 amount_vat: 0 amount_gross: 592 amount_withholding_tax: 0 amount_other_withholding_tax: 0 tax_deductibility: 50 vat_deductibility: 100 payments_list: - amount: 592 due_date: '2021-08-15' paid_date: '2021-08-15' id: 777 payment_terms: days: 0 type: standard status: paid payment_account: id: 222 name: Contanti virtual: false description: Modified document. delete: summary: Delete Received Document operationId: deleteReceivedDocument responses: '200': description: Document removed. '401': description: Unauthorized '404': description: Not Found tags: - Received Documents description: Deletes the specified document. security: - OAuth2AuthenticationCodeFlow: - received_documents:a - stock:a - ManualAuth: [] parameters: [] /c/{company_id}/received_documents/totals: parameters: - $ref: '#/components/parameters/company_id' post: summary: Get New Received Document Totals operationId: getNewReceivedDocumentTotals responses: '200': $ref: '#/components/responses/GetNewReceivedDocumentTotalsResponse' '401': description: Unauthorized '404': description: Not Found description: Returns the totals for a new document. security: - OAuth2AuthenticationCodeFlow: - received_documents:a - stock:a - ManualAuth: [] tags: - Received Documents parameters: [] requestBody: content: application/json: schema: title: GetNewReceivedDocumentTotalsRequest type: object description: '' properties: data: type: object title: ReceivedDocument properties: id: type: integer description: Received document id type: title: ReceivedDocumentType type: string default: expense enum: - expense - passive_credit_note - passive_delivery_note description: Received document type entity: title: Entity type: object properties: id: type: integer description: Entity id code: type: string example: '123' description: Entity code name: type: string example: Rossi S.r.l. description: Entity name type: title: EntityType type: string default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name last_name: type: string description: Entity last name contact_person: type: string description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code address_street: type: string example: Via dei tigli, 12 description: Entitity address street address_postal_code: type: string example: '24010' description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city address_province: type: string example: BG description: Entity address province address_extra: type: string description: Entity address extra info country: type: string example: Italia description: Entity country country_iso: type: string example: Italia description: Entity country iso code email: type: string example: mario.rossi@example.it description: Entity email certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email phone: type: string description: Entity phone fax: type: string description: Entity fax notes: type: string description: Entity extra default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms default_vat: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true is_disabled: type: boolean description: Is the vat type disabled description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name bank_iban: type: string description: |- [Only for client] Client bank iban bank_swift_code: type: string description: |- [Only for client] Client bank swift code shipping_address: type: string description: |- [Only for client] Client Shipping address e_invoice: type: boolean description: |- [Only for client] Use e-invoices. ei_code: type: string description: |- [Only for client] E-invoices code. has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date created_at: type: string description: Entity creation date updated_at: type: string description: Entity last update date date: type: string description: Received document date [defaults to today's date] format: date category: type: string description: Received document category description: type: string description: Received document description amount_net: type: number description: Received document total net amount amount_vat: type: number description: Received document total vat amount amount_withholding_tax: type: number description: Received document withholding tax amount amount_other_withholding_tax: type: number description: Received document other withholding tax amount amount_gross: type: number description: |- [Read Only] Received document total gross amount readOnly: true amortization: type: number description: Received document amortization value rc_center: type: string description: Received document revenue center invoice_number: type: string description: Received document invoice number is_marked: type: boolean description: Received document is marked is_detailed: type: boolean description: Received document has items e_invoice: type: boolean description: |- [Read Only] Received document is an e-invoice next_due_date: type: string description: |- [Read Only] Received document date of the next not paid payment format: date readOnly: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR symbol: type: string description: Currency symbol example: € exchange_rate: type: string description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code tax_deductibility: type: number description: Received document tax deducibility percentage maximum: 100 minimum: 0 vat_deductibility: type: number description: Received document vat deducibility percentage maximum: 100 minimum: 0 items_list: type: array items: title: ReceivedDocumentItemsListItem type: object properties: id: type: integer description: Received document item id nullable: true product_id: type: integer description: Received document product id nullable: true code: type: string description: Received document item product code nullable: true name: type: string description: Received document item product name nullable: true measure: type: string description: Received document item measure nullable: true net_price: type: number description: Received document item product net price nullable: true category: type: string description: Received document item product category nullable: true qty: type: number description: Received document item quantity nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true stock: type: number description: >- Received document item product number of items in stock nullable: true payments_list: type: array items: title: ReceivedDocumentPaymentsListItem type: object properties: id: type: integer description: Received document payment id nullable: true amount: type: number description: Received document payment total amount nullable: true due_date: type: string description: Due date format: date nullable: true paid_date: type: string description: Received document payment paid date format: date nullable: true payment_terms: type: object nullable: true properties: days: type: integer description: >- Received document payment number of days by which the payment must be made nullable: true type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type status: type: string description: Received document payment status nullable: true payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Received document url of the attached file readOnly: true attachment_preview_url: type: string description: |- [Temporary] [Read Only] Received document url of the attachment preview readOnly: true auto_calculate: type: boolean description: >- Received document total items amount and total payments amount can differ if this field is set to false attachment_token: type: string description: >- [Write Only] Received document attachment token returned by POST /received_documents/attachment locked: type: boolean description: Received Document can't be edited created_at: type: string description: Received document creation date updated_at: type: string description: Received document last update date required: - entity examples: example-1: value: data: type: expense description: Soggiorno di lavoro amortization: 1 rc_center: '' invoice_number: '' is_marked: false is_detailed: false e_invoice: false created_at: '2021-08-15 14:02:02' updated_at: '2021-08-15 14:02:02' entity: id: 111 name: Hotel Rubino Palace date: '2021-08-15' next_due_date: '2021-08-15' currency: id: EUR exchange_rate: '1.00000' symbol: € amount_net: 592 amount_vat: 10 amount_withholding_tax: 0 amount_other_withholding_tax: 0 tax_deductibility: 50 vat_deductibility: 100 payments_list: - amount: 592 due_date: '2021-08-15' paid_date: '2021-08-15' id: 777 payment_terms: days: 0 type: standard status: paid description: Received document. /c/{company_id}/received_documents/{document_id}/totals: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' post: summary: Get Existing Received Document Totals operationId: getExistingReceivedDocumentTotals responses: '200': $ref: '#/components/responses/GetExistingReceivedDocumentTotalsResponse' tags: - Received Documents description: Returns the totals for the specified document. security: - OAuth2AuthenticationCodeFlow: - received_documents:a - stock:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: GetExistingReceivedDocumentTotals type: object properties: data: type: object title: ReceivedDocument properties: id: type: integer description: Received document id type: title: ReceivedDocumentType type: string default: expense enum: - expense - passive_credit_note - passive_delivery_note description: Received document type entity: title: Entity type: object properties: id: type: integer description: Entity id code: type: string example: '123' description: Entity code name: type: string example: Rossi S.r.l. description: Entity name type: title: EntityType type: string default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name last_name: type: string description: Entity last name contact_person: type: string description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code address_street: type: string example: Via dei tigli, 12 description: Entitity address street address_postal_code: type: string example: '24010' description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city address_province: type: string example: BG description: Entity address province address_extra: type: string description: Entity address extra info country: type: string example: Italia description: Entity country country_iso: type: string example: Italia description: Entity country iso code email: type: string example: mario.rossi@example.it description: Entity email certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email phone: type: string description: Entity phone fax: type: string description: Entity fax notes: type: string description: Entity extra default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms default_vat: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true is_disabled: type: boolean description: Is the vat type disabled description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name bank_iban: type: string description: |- [Only for client] Client bank iban bank_swift_code: type: string description: |- [Only for client] Client bank swift code shipping_address: type: string description: |- [Only for client] Client Shipping address e_invoice: type: boolean description: |- [Only for client] Use e-invoices. ei_code: type: string description: |- [Only for client] E-invoices code. has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date created_at: type: string description: Entity creation date updated_at: type: string description: Entity last update date date: type: string description: Received document date [defaults to today's date] format: date category: type: string description: Received document category description: type: string description: Received document description amount_net: type: number description: Received document total net amount amount_vat: type: number description: Received document total vat amount amount_withholding_tax: type: number description: Received document withholding tax amount amount_other_withholding_tax: type: number description: Received document other withholding tax amount amount_gross: type: number description: |- [Read Only] Received document total gross amount readOnly: true amortization: type: number description: Received document amortization value rc_center: type: string description: Received document revenue center invoice_number: type: string description: Received document invoice number is_marked: type: boolean description: Received document is marked is_detailed: type: boolean description: Received document has items e_invoice: type: boolean description: |- [Read Only] Received document is an e-invoice next_due_date: type: string description: |- [Read Only] Received document date of the next not paid payment format: date readOnly: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR symbol: type: string description: Currency symbol example: € exchange_rate: type: string description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code tax_deductibility: type: number description: Received document tax deducibility percentage maximum: 100 minimum: 0 vat_deductibility: type: number description: Received document vat deducibility percentage maximum: 100 minimum: 0 items_list: type: array items: title: ReceivedDocumentItemsListItem type: object properties: id: type: integer description: Received document item id nullable: true product_id: type: integer description: Received document product id nullable: true code: type: string description: Received document item product code nullable: true name: type: string description: Received document item product name nullable: true measure: type: string description: Received document item measure nullable: true net_price: type: number description: Received document item product net price nullable: true category: type: string description: Received document item product category nullable: true qty: type: number description: Received document item quantity nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true stock: type: number description: >- Received document item product number of items in stock nullable: true payments_list: type: array items: title: ReceivedDocumentPaymentsListItem type: object properties: id: type: integer description: Received document payment id nullable: true amount: type: number description: Received document payment total amount nullable: true due_date: type: string description: Due date format: date nullable: true paid_date: type: string description: Received document payment paid date format: date nullable: true payment_terms: type: object nullable: true properties: days: type: integer description: >- Received document payment number of days by which the payment must be made nullable: true type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type status: type: string description: Received document payment status nullable: true payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Received document url of the attached file readOnly: true attachment_preview_url: type: string description: |- [Temporary] [Read Only] Received document url of the attachment preview readOnly: true auto_calculate: type: boolean description: >- Received document total items amount and total payments amount can differ if this field is set to false attachment_token: type: string description: >- [Write Only] Received document attachment token returned by POST /received_documents/attachment locked: type: boolean description: Received Document can't be edited created_at: type: string description: Received document creation date updated_at: type: string description: Received document last update date required: - entity description: '' examples: example-1: value: data: amount_vat: 20 description: Received document. /c/{company_id}/received_documents/attachment: parameters: - $ref: '#/components/parameters/company_id' post: summary: Upload Received Document Attachment operationId: uploadReceivedDocumentAttachment responses: '200': $ref: '#/components/responses/UploadReceivedDocumentAttachmentResponse' '401': description: Unauthorized tags: - Received Documents description: >- Uploads an attachment destined to a received document. The actual association between the document and the attachment must be implemented separately, using the returned token. security: - OAuth2AuthenticationCodeFlow: - received_documents:a - stock:a - ManualAuth: [] parameters: [] requestBody: content: multipart/form-data: schema: title: Attachment type: object properties: filename: type: string description: Attachment file name example: attachment.pdf attachment: type: string description: >- Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx] format: binary description: '' examples: example-1: value: filename: spesa_HotelRubino attachment: spesa_08_08_2020.pdf description: Attachment. /c/{company_id}/received_documents/{document_id}/attachment: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' delete: summary: Delete Received Document Attachment operationId: deleteReceivedDocumentAttachment responses: '200': description: File removed '401': description: Unauthorized '404': description: Not Found tags: - Received Documents description: Removes the attachment of the specified document. security: - OAuth2AuthenticationCodeFlow: - received_documents:a - stock:a - ManualAuth: [] parameters: [] /c/{company_id}/received_documents/info: parameters: - $ref: '#/components/parameters/company_id' get: summary: Get Received Document Pre-Create Info tags: - Received Documents responses: '200': $ref: '#/components/responses/GetReceivedDocumentPreCreateInfoResponse' operationId: getReceivedDocumentPreCreateInfo description: Retrieves the information useful while creating a new document. security: - OAuth2AuthenticationCodeFlow: - received_documents:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/received_document_type' /c/{company_id}/receipts: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Receipts tags: - Receipts responses: '200': $ref: '#/components/responses/ListReceiptsResponse' '401': description: Unauthorized operationId: listReceipts description: Lists the receipts. security: - OAuth2AuthenticationCodeFlow: - receipts:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/q' post: summary: Create Receipt operationId: createReceipt responses: '200': $ref: '#/components/responses/CreateReceiptResponse' '401': description: Unauthorized description: Creates a new receipt. security: - OAuth2AuthenticationCodeFlow: - receipts:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: CreateReceiptRequest type: object description: '' properties: data: title: Receipt type: object properties: id: type: integer description: Receipt id date: type: string description: Receipt date format: date number: type: number description: Receipt number numeration: type: string description: Receipt numeration amount_net: type: number description: Receipt total net amount amount_vat: type: number description: Receipt total vat amount amount_gross: type: number description: Receipt total gross amount use_gross_prices: type: boolean description: Receipt uses gross prices default: false type: type: string title: ReceiptType enum: - till_receipt - sales_receipt description: Receipt type description: type: string description: Receipt description rc_center: type: string description: Receipt revenue center created_at: type: string description: Receipt creation date updated_at: type: string description: Receipt last update date payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name items_list: type: array items: title: ReceiptItemsListItem type: object properties: id: type: integer description: Receipt item id nullable: true amount_net: type: number description: Receipt item total net amount nullable: true amount_gross: type: number description: Receipt item total gross amount nullable: true category: type: string description: Receipt item category nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true required: - date - type - payment_account autocomplete_number: type: boolean description: If true, the number is autocompleted progressively. examples: example-1: value: data: date: '2021-08-19' number: 6 numeration: REC006 amount_net: 8.2 amount_vat: 1.8 type: sales_receipt description: cassa 1 rc_center: '' payment_account: id: 555 name: contanti items_list: - id: 888 amount_net: 8.2 amount_vat: 1.8 category: altro vat: id: 0 value: 22 description: iva description: The Receipt to create. tags: - Receipts /c/{company_id}/receipts/{document_id}: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' get: summary: Get Receipt tags: - Receipts responses: '200': $ref: '#/components/responses/GetReceiptResponse' '401': description: Unauthorized '404': description: Not Found operationId: getReceipt description: Gets the specified receipt. parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' security: - OAuth2AuthenticationCodeFlow: - receipts:r - ManualAuth: [] put: summary: Modify Receipt operationId: modifyReceipt responses: '200': $ref: '#/components/responses/ModifyReceiptResponse' '401': description: Unauthorized '404': description: Not Found tags: - Receipts description: Modifies the specified receipt. security: - OAuth2AuthenticationCodeFlow: - receipts:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: ModifyReceiptRequest type: object description: '' properties: data: title: Receipt type: object properties: id: type: integer description: Receipt id date: type: string description: Receipt date format: date number: type: number description: Receipt number numeration: type: string description: Receipt numeration amount_net: type: number description: Receipt total net amount amount_vat: type: number description: Receipt total vat amount amount_gross: type: number description: Receipt total gross amount use_gross_prices: type: boolean description: Receipt uses gross prices default: false type: type: string title: ReceiptType enum: - till_receipt - sales_receipt description: Receipt type description: type: string description: Receipt description rc_center: type: string description: Receipt revenue center created_at: type: string description: Receipt creation date updated_at: type: string description: Receipt last update date payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name items_list: type: array items: title: ReceiptItemsListItem type: object properties: id: type: integer description: Receipt item id nullable: true amount_net: type: number description: Receipt item total net amount nullable: true amount_gross: type: number description: Receipt item total gross amount nullable: true category: type: string description: Receipt item category nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true required: - date - type - payment_account examples: example-1: value: data: date: '2021-08-19' number: 6 numeration: REC006 amount_net: 8.2 amount_vat: 1.8 type: sales_receipt description: cassa 1 rc_center: '' payment_account: id: 555 name: contanti items_list: - id: 888 amount_net: 8.2 amount_vat: 1.8 category: altro vat: id: 0 value: 22 description: iva description: Modified receipt. delete: summary: Delete Receipt operationId: deleteReceipt responses: '200': description: Document removed. '401': description: Unauthorized '404': description: Not Found description: Deletes the specified receipt. security: - OAuth2AuthenticationCodeFlow: - receipts:a - ManualAuth: [] parameters: [] tags: - Receipts /c/{company_id}/receipts/info: parameters: - $ref: '#/components/parameters/company_id' get: summary: Get Receipt Pre-Create Info tags: - Receipts responses: '200': $ref: '#/components/responses/GetReceiptPreCreateInfoResponse' '401': description: Unauthorized '404': description: Not Found operationId: getReceiptPreCreateInfo description: Retrieves the information useful while creating a new receipt. security: - OAuth2AuthenticationCodeFlow: - receipts:r - ManualAuth: [] parameters: [] /c/{company_id}/receipts/monthly_totals: parameters: - $ref: '#/components/parameters/company_id' get: summary: Get Receipts Monthly Totals tags: - Receipts responses: '200': $ref: '#/components/responses/GetReceiptsMonthlyTotalsResponse' '401': description: Unauthorized '404': description: Not Found operationId: getReceiptsMonthlyTotals description: Returns the monthly totals by year and receipt type. security: - OAuth2AuthenticationCodeFlow: - receipts:r - ManualAuth: [] parameters: - in: query name: type schema: type: string enum: - sales_receipt - till_receipt description: Receipt Type required: true - schema: type: string in: query name: year required: true description: Year for which you want monthly totals /c/{company_id}/taxes: parameters: - $ref: '#/components/parameters/company_id' get: summary: List F24 tags: - Taxes responses: '200': $ref: '#/components/responses/ListF24Response' '401': description: Unauthorized operationId: listF24 description: Lists the F24s. security: - OAuth2AuthenticationCodeFlow: - taxes:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' - $ref: '#/components/parameters/q' post: summary: Create F24 operationId: createF24 responses: '200': $ref: '#/components/responses/CreateF24Response' '401': description: Unauthorized '404': description: Not Found tags: - Taxes description: Creates a new F24. security: - OAuth2AuthenticationCodeFlow: - taxes:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: CreateF24Request type: object properties: data: title: F24 type: object properties: id: type: integer description: F24 id due_date: type: string format: date example: '2018-02-12' description: F24 due date status: title: F24Status type: string enum: - paid - not_paid - reversed description: F24 status payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name amount: type: number description: F24 amount example: 300 attachment_url: type: string description: |- [Temporary] [Read Only] F24 url of the attached file readOnly: true attachment_token: type: string description: |- [Write Only] F24 attachment token returned by POST /taxes/attachment writeOnly: true description: type: string description: F24 description required: - due_date - amount - description description: '' examples: example-1: value: data: amount: 840.36 description: PAGAMENTO IVA 2021 due_date: '2021-12-31' status: paid payment_account: id: 111 attachment_token: b19c01da9b1688fb73d0d9e8ad description: The F24 to create /c/{company_id}/taxes/{document_id}: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' get: summary: Get F24 tags: - Taxes responses: '200': $ref: '#/components/responses/GetF24Response' '401': description: Unauthorized '404': description: Not Found operationId: getF24 description: Gets the specified F24. security: - OAuth2AuthenticationCodeFlow: - taxes:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' put: summary: Modify F24 operationId: modifyF24 responses: '200': $ref: '#/components/responses/ModifyF24Response' '401': description: Unauthorized '404': description: Not Found description: Modifies the specified F24. tags: - Taxes security: - OAuth2AuthenticationCodeFlow: - taxes:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: ModifyF24Request type: object properties: data: title: F24 type: object properties: id: type: integer description: F24 id due_date: type: string format: date example: '2018-02-12' description: F24 due date status: title: F24Status type: string enum: - paid - not_paid - reversed description: F24 status payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name amount: type: number description: F24 amount example: 300 attachment_url: type: string description: |- [Temporary] [Read Only] F24 url of the attached file readOnly: true attachment_token: type: string description: |- [Write Only] F24 attachment token returned by POST /taxes/attachment writeOnly: true description: type: string description: F24 description required: - due_date - amount - description description: '' examples: example-1: value: data: amount: 840.36 description: PAGAMENTO IVA 2021 due_date: '2021-12-31' status: paid payment_account: id: 111 description: The F24 delete: summary: Delete F24 operationId: deleteF24 responses: '200': description: Document removed. '401': description: Unauthorized '404': description: Not Found tags: - Taxes description: Removes the specified F24. security: - OAuth2AuthenticationCodeFlow: - taxes:a - ManualAuth: [] parameters: [] /c/{company_id}/taxes/attachment: parameters: - $ref: '#/components/parameters/company_id' post: summary: Upload F24 Attachment tags: - Taxes responses: '200': $ref: '#/components/responses/UploadF24AttachmentResponse' operationId: uploadF24Attachment description: >- Uploads an attachment destined to a F24. The actual association between the document and the attachment must be implemented separately, using the returned token. security: - OAuth2AuthenticationCodeFlow: - taxes:a - ManualAuth: [] parameters: [] requestBody: content: multipart/form-data: schema: title: Attachment type: object properties: filename: type: string description: Attachment file name example: attachment.pdf attachment: type: string description: >- Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx] format: binary description: '' examples: example-1: value: filename: F24_IVA21 attachment: pagamento_f24_31_12_2021.pdf description: Attachment. /c/{company_id}/taxes/{document_id}/attachment: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' delete: summary: Delete F24 Attachment tags: - Taxes responses: '200': description: File Removed. '401': description: Unauthorized '404': description: Not Found operationId: deleteF24Attachment description: Removes the attachment of the specified F24. security: - OAuth2AuthenticationCodeFlow: - taxes:a - ManualAuth: [] parameters: [] /c/{company_id}/archive: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Archive Documents tags: - Archive responses: '200': $ref: '#/components/responses/ListArchiveDocumentsResponse' '401': description: Unauthorized '404': description: Not Found operationId: listArchiveDocuments description: Lists the archive documents. security: - OAuth2AuthenticationCodeFlow: - archive:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' - $ref: '#/components/parameters/q' post: summary: Create Archive Document operationId: createArchiveDocument responses: '200': $ref: '#/components/responses/CreateArchiveDocumentResponse' '401': description: Unauthorized '404': description: Not Found tags: - Archive description: Creates a new archive document. security: - OAuth2AuthenticationCodeFlow: - archive:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: CreateArchiveDocumentRequest type: object properties: data: title: ArchiveDocument type: object properties: id: type: integer description: Archive document id date: type: string format: date description: Archive document date description: type: string description: Archive Document description attachment_url: type: string description: |- [Temporary] [Read Only] Archive Document url of the attached file readOnly: true category: type: string description: Archive document category attachment_token: type: string description: >- [Write Only] [Required] Archive document attachment token returned by POST /archive/attachment writeOnly: true required: - date - description - category description: '' examples: example-1: value: data: date: '2021-08-20' category: Altri documenti description: spesa 1 attachment_token: ibfjdbf94ey9w94g3w894qbasrga description: The Archive Document. /c/{company_id}/archive/{document_id}: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/document_id' get: summary: Get Archive Document tags: - Archive responses: '200': $ref: '#/components/responses/GetArchiveDocumentResponse' '401': description: Unauthorized '404': description: Not Found operationId: getArchiveDocument description: Gets the specified archive document. security: - OAuth2AuthenticationCodeFlow: - archive:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' put: summary: Modify Archive Document operationId: modifyArchiveDocument responses: '200': $ref: '#/components/responses/ModifyArchiveDocumentResponse' '401': description: Unauthorized '404': description: Not Found tags: - Archive description: Modifies the specified archive document. security: - OAuth2AuthenticationCodeFlow: - archive:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: ModifyArchiveDocumentRequest type: object properties: data: title: ArchiveDocument type: object properties: id: type: integer description: Archive document id date: type: string format: date description: Archive document date description: type: string description: Archive Document description attachment_url: type: string description: |- [Temporary] [Read Only] Archive Document url of the attached file readOnly: true category: type: string description: Archive document category attachment_token: type: string description: >- [Write Only] [Required] Archive document attachment token returned by POST /archive/attachment writeOnly: true required: - date - description - category description: '' examples: example-1: value: data: date: '2021-08-20' category: Altri documenti description: spesa 2 description: Modified Archive Document delete: summary: Delete Archive Document operationId: deleteArchiveDocument responses: '200': description: Document removed. '401': description: Unauthorized '404': description: Not Found tags: - Archive description: Deletes the specified archive document. security: - OAuth2AuthenticationCodeFlow: - archive:a - ManualAuth: [] parameters: [] /c/{company_id}/archive/attachment: parameters: - $ref: '#/components/parameters/company_id' post: summary: Upload Archive Document Attachment tags: - Archive responses: '200': $ref: '#/components/responses/UploadArchiveAttachmentResponse' '401': description: Unauthorized '404': description: Not Found operationId: uploadArchiveDocumentAttachment description: >- Uploads an attachment destined to an archive document. The actual association between the document and the attachment must be implemented separately, using the returned token. security: - OAuth2AuthenticationCodeFlow: - archive:a - ManualAuth: [] requestBody: content: multipart/form-data: schema: title: Attachment type: object properties: filename: type: string description: Attachment file name example: attachment.pdf attachment: type: string description: >- Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx] format: binary examples: example-1: value: filename: spesa_altro attachment: spesa_20_08_2020.pdf description: Attachment. parameters: [] /c/{company_id}/cashbook: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Cashbook Entries tags: - Cashbook responses: '200': $ref: '#/components/responses/ListCashbookEntriesResponse' '401': description: Unauthorized '404': description: Not Found operationId: listCashbookEntries description: Lists the cashbook entries. security: - OAuth2AuthenticationCodeFlow: - cashbook:r - ManualAuth: [] parameters: - schema: type: string in: query name: date_from description: Start date. required: true - schema: type: string in: query name: date_to description: End date. required: true - schema: type: integer in: query name: year description: Filter cashbook by year. - schema: type: string enum: - all - in - out in: query name: type description: Filter cashbook by type. - schema: type: integer in: query name: payment_account_id description: Filter by payment account. post: summary: Create Cashbook Entry operationId: createCashbookEntry responses: '200': $ref: '#/components/responses/CreateCashbookEntryResponse' '401': description: Unauthorized '404': description: Not Found tags: - Cashbook description: Creates a new cashbook entry. security: - OAuth2AuthenticationCodeFlow: - cashbook:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: CreateCashbookEntryRequest type: object description: '' properties: data: title: CashbookEntry type: object properties: id: type: string description: Cashbook id date: description: Cashbook date format: date type: string description: type: string description: Cashbook description kind: title: CashbookEntryKind type: string enum: - cashbook - issued_document - received_document - tax - receipt description: Cashbook kind type: title: CashbookEntryType type: string enum: - in - out description: Cashbook type entity_name: type: string description: Cashbook entity name document: type: object properties: id: type: integer description: Cashbook related document id type: type: string description: Cashbook related document type path: type: string description: Cashbook related document path amount_in: type: number description: |- [Only for cashbook entry in] Cashbook total amount in payment_account_in: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual description: |- [Only for cashbook entry in] Cashbook payment account in required: - name amount_out: type: number description: |- [Only for cashbook entry out] Cashbook total amount out payment_account_out: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual description: |- [Only for cashbook entry out] Cashbook payment account out required: - name required: - id - date - description - kind examples: example-1: value: data: date: '2021-08-24' amount_in: 122 payment_account_in: id: 333 description: Fattura n. 201/2021 entity_name: Rossi S.r.l. kind: issued_document document: id: 54321 type: in description: | Cashbook entry. /c/{company_id}/cashbook/{document_id}: parameters: - $ref: '#/components/parameters/company_id' - schema: type: string name: document_id in: path required: true description: The ID of the document. get: summary: Get Cashbook Entry tags: - Cashbook responses: '200': $ref: '#/components/responses/GetCashbookEntryResponse' '401': description: Unauthorized '404': description: Not Found operationId: getCashbookEntry description: Gets the specified cashbook entry. security: - OAuth2AuthenticationCodeFlow: - cashbook:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' put: summary: Modify Cashbook Entry operationId: modifyCashbookEntry responses: '200': $ref: '#/components/responses/ModifyCashbookEntryResponse' '401': description: Unauthorized '404': description: Not Found tags: - Cashbook description: Modifies the specified cashbook entry. security: - OAuth2AuthenticationCodeFlow: - cashbook:a - ManualAuth: [] parameters: [] requestBody: content: application/json: schema: title: ModifyCashbookEntryRequest type: object description: '' properties: data: title: CashbookEntry type: object properties: id: type: string description: Cashbook id date: description: Cashbook date format: date type: string description: type: string description: Cashbook description kind: title: CashbookEntryKind type: string enum: - cashbook - issued_document - received_document - tax - receipt description: Cashbook kind type: title: CashbookEntryType type: string enum: - in - out description: Cashbook type entity_name: type: string description: Cashbook entity name document: type: object properties: id: type: integer description: Cashbook related document id type: type: string description: Cashbook related document type path: type: string description: Cashbook related document path amount_in: type: number description: |- [Only for cashbook entry in] Cashbook total amount in payment_account_in: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual description: |- [Only for cashbook entry in] Cashbook payment account in required: - name amount_out: type: number description: |- [Only for cashbook entry out] Cashbook total amount out payment_account_out: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual description: |- [Only for cashbook entry out] Cashbook payment account out required: - name required: - id - date - description - kind examples: example-1: value: data: date: '2021-08-24' amount_in: 122 payment_account_in: id: 333 description: Fattura n. 201/2021 entity_name: Rossi S.r.l. description: Cashbook Entry delete: summary: Delete Cashbook Entry operationId: deleteCashbookEntry responses: '200': description: Document removed. '401': description: Unauthorized '404': description: Not Found description: Deletes the specified cashbook entry. security: - OAuth2AuthenticationCodeFlow: - cashbook:a - ManualAuth: [] tags: - Cashbook /info/countries: get: summary: List Countries tags: - Info responses: '200': $ref: '#/components/responses/ListCountriesResponse' '401': description: Unauthorized operationId: listCountries description: Lists the supported countries. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /info/detailed_countries: get: summary: List Detailed Countries tags: - Info responses: '200': $ref: '#/components/responses/ListDetailedCountriesResponse' '401': description: Unauthorized operationId: listDetailedCountries description: Lists the supported countries. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /info/cities: get: summary: List Cities tags: - Info responses: '200': $ref: '#/components/responses/ListCitiesResponse' operationId: listCities description: Lists the Italian cities. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: - schema: type: string in: query name: postal_code description: Postal code for filtering. - schema: type: string in: query name: city description: City for filtering (ignored if postal_code is passed). /info/languages: get: summary: List Languages tags: - Info responses: '200': $ref: '#/components/responses/ListLanguagesResponse' '401': description: Unauthorized operationId: listLanguages description: Lists the supported languages. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /info/templates: get: summary: List Templates tags: - Info responses: '200': $ref: '#/components/responses/ListTemplatesResponse' '401': description: Unauthorized operationId: listTemplates description: Lists the available templates. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: - schema: type: string enum: - all - standard - delivery_note - accompanying_invoice default: all in: query name: type description: Type of the templates. - schema: type: boolean default: 'false' in: query name: by_type description: >- [Only if type=all] If true, splits the list in objects, grouping templates by type. /info/currencies: get: summary: List Currencies tags: - Info responses: '200': $ref: '#/components/responses/ListCurrenciesResponse' '401': description: Unauthorized operationId: listCurrencies description: Lists the supported currencies. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /info/measures: get: summary: List Units of Measure tags: - Info responses: '200': $ref: '#/components/responses/ListUnitsOfMeasureResponse' '401': description: Unauthorized operationId: listUnitsOfMeasure description: Lists the units of measure. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /info/dn_causals: get: summary: List Delivery Notes Default Causals tags: - Info responses: '200': $ref: '#/components/responses/ListDeliveryNotesDefaultCausalsResponse' '401': description: Unauthorized operationId: listDeliveryNotesDefaultCausals description: Lists the delivery note default causals. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /c/{company_id}/info/vat_types: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Vat Types tags: - Info responses: '200': $ref: '#/components/responses/ListVatTypesResponse' '401': description: Unauthorized '404': description: Not Found operationId: listVatTypes security: - OAuth2AuthenticationCodeFlow: - settings:r - ManualAuth: [] parameters: - $ref: '#/components/parameters/fieldset' description: Lists the available vat types. /c/{company_id}/info/payment_methods: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Payment Methods tags: - Info responses: '200': $ref: '#/components/responses/ListPaymentMethodsResponse' '401': description: Unauthorized '404': description: Not Found operationId: listPaymentMethods description: Lists the available payment methods. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' - $ref: '#/components/parameters/sort' /c/{company_id}/info/payment_accounts: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Payment Accounts tags: - Info responses: '200': $ref: '#/components/responses/ListPaymentAccountsResponse' '401': description: Unauthorized '404': description: Not Found operationId: listPaymentAccounts description: Lists the available payment accounts. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' - $ref: '#/components/parameters/sort' /c/{company_id}/info/revenue_centers: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Revenue Centers tags: - Info responses: '200': $ref: '#/components/responses/ListRevenueCentersResponse' '401': description: Unauthorized '404': description: Not Found operationId: listRevenueCenters description: Lists the revenue centers. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /c/{company_id}/info/cost_centers: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Cost Centers tags: - Info responses: '200': $ref: '#/components/responses/ListCostCentersResponse' '401': description: Unauthorized '404': description: Not Found operationId: listCostCenters description: Lists the cost centers. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /c/{company_id}/info/product_categories: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Product Categories tags: - Info responses: '200': $ref: '#/components/responses/ListProductCategoriesResponse' '401': description: Unauthorized '404': description: Not Found operationId: listProductCategories description: Lists the product categories. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: - schema: type: string enum: - products - issued_documents - received_documents in: query name: context description: Categories resource type. required: true /c/{company_id}/info/received_document_categories: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Received Document Categories tags: - Info responses: '200': $ref: '#/components/responses/ListReceivedDocumentCategoriesResponse' operationId: listReceivedDocumentCategories description: Lists the received document categories. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /c/{company_id}/info/archive_categories: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Archive Categories tags: - Info responses: '200': $ref: '#/components/responses/ListArchiveCategoriesResponse' '401': description: Unauthorized '404': description: Not Found operationId: listArchiveCategories description: Lists the archive categories. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: [] /c/{company_id}/settings/payment_methods: parameters: - $ref: '#/components/parameters/company_id' post: summary: Create Payment Method tags: - Settings operationId: createPaymentMethod description: Creates a new payment method. security: - OAuth2AuthenticationCodeFlow: - settings:a - ManualAuth: [] responses: '200': $ref: '#/components/responses/CreatePaymentMethodResponse' requestBody: content: application/json: schema: title: CreatePaymentMethodRequest type: object properties: data: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method required: - name examples: example-1: value: data: id: 386683 name: Bonifico bancario is_default: true type: standard details: - title: Banca description: Sao Paulo default_payment_account: id: 12345 name: conto banca SP /c/{company_id}/settings/payment_methods/{payment_method_id}: parameters: - $ref: '#/components/parameters/company_id' - schema: type: integer name: payment_method_id in: path required: true description: The Referred Payment Method Id. get: summary: Get Payment Method tags: - Settings responses: '200': $ref: '#/components/responses/GetPaymentMethodResponse' operationId: getPaymentMethod description: Gets the specified payment method. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' put: summary: Modify Payment Method tags: - Settings responses: '200': $ref: '#/components/responses/ModifyPaymentMethodResponse' operationId: modifyPaymentMethod security: - OAuth2AuthenticationCodeFlow: - settings:a - ManualAuth: [] description: Modifies the specified payment method. requestBody: content: application/json: schema: title: ModifyPaymentMethodRequest type: object properties: data: type: object title: PaymentMethod properties: id: type: integer description: Payment method id name: type: string description: Payment method name type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean description: Payment method is default default_payment_account: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name details: maxItems: 5 type: array description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban bank_name: type: string description: Payment method bank name bank_beneficiary: type: string description: Payment method bank beneficiary ei_payment_method: type: string description: E-invoice payment method required: - name examples: example-1: value: data: id: 386683 name: Bonifico bancario is_default: true type: standard details: - title: Banca description: Sao Paulo default_payment_account: id: 12345 name: conto banca SP description: '' delete: summary: Delete Payment Method tags: - Settings responses: '200': description: OK operationId: deletePaymentMethod description: Deletes the specified payment method. security: - OAuth2AuthenticationCodeFlow: - settings:a - ManualAuth: [] /c/{company_id}/settings/payment_accounts: parameters: - $ref: '#/components/parameters/company_id' post: summary: Create Payment Account tags: - Settings responses: '200': $ref: '#/components/responses/CreatePaymentAccountResponse' operationId: createPaymentAccount security: - OAuth2AuthenticationCodeFlow: - settings:a - ManualAuth: [] description: Creates a new payment account. requestBody: content: application/json: schema: title: CreatePaymentAccountRequest type: object properties: data: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name examples: example-1: value: data: id: 12345 name: Indesa type: bank iban: IT17Q0051343200000003497636 sia: T1234 virtual: false /c/{company_id}/settings/payment_accounts/{payment_account_id}: parameters: - $ref: '#/components/parameters/company_id' - schema: type: integer name: payment_account_id in: path required: true description: The Referred Payment Account Id. get: summary: Get Payment Account tags: - Settings responses: '200': $ref: '#/components/responses/GetPaymentAccountResponse' operationId: getPaymentAccount description: Gets the specified payment account. parameters: - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/fieldset' security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] put: summary: Modify Payment Account tags: - Settings responses: '200': $ref: '#/components/responses/ModifyPaymentAccountResponse' operationId: modifyPaymentAccount description: Modifies the specified payment account. security: - OAuth2AuthenticationCodeFlow: - settings:a - ManualAuth: [] requestBody: content: application/json: schema: title: ModifyPaymentAccountRequest type: object properties: data: type: object title: PaymentAccount properties: id: type: integer description: Payment account id name: type: string description: Payment account name example: Conto Banca Intesa type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string description: Payment account iban sia: type: string description: Payment account sia cuc: type: string description: Payment account cuc virtual: type: boolean description: Payment method is virtual required: - name examples: example-1: value: data: id: 0 name: Conto Banca Intesa type: standard iban: string sia: string cuc: string virtual: true delete: summary: Delete Payment Account tags: - Settings responses: '200': description: OK operationId: deletePaymentAccount description: Deletes the specified payment account. security: - OAuth2AuthenticationCodeFlow: - settings:a - ManualAuth: [] /c/{company_id}/settings/vat_types: parameters: - $ref: '#/components/parameters/company_id' post: summary: Create Vat Type tags: - Settings responses: '200': $ref: '#/components/responses/CreateVatTypeResponse' operationId: createVatType description: Creates a vat type. security: - OAuth2AuthenticationCodeFlow: - settings:a - ManualAuth: [] requestBody: content: application/json: schema: title: CreateVatTypeRequest type: object properties: data: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 maximum: 100 minimum: 0 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true default: true is_disabled: type: boolean description: Is the vat type disabled required: - value examples: example-1: value: data: id: 0 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: true ei_type: 2 ei_description: string editable: true is_disabled: true description: '' /c/{company_id}/settings/vat_types/{vat_type_id}: parameters: - $ref: '#/components/parameters/company_id' - schema: type: integer name: vat_type_id in: path required: true description: The Referred Vat Type Id. get: summary: Get Vat Type tags: - Settings responses: '200': $ref: '#/components/responses/GetVatTypeResponse' operationId: getVatType description: Gets the specified vat type. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] put: summary: Modify Vat Type tags: - Settings responses: '200': $ref: '#/components/responses/ModifyVatTypeResponse' operationId: modifyVatType description: Modifies the specified vat type. security: - OAuth2AuthenticationCodeFlow: - settings:a - ManualAuth: [] requestBody: content: application/json: schema: type: object properties: data: type: object title: VatType properties: id: type: integer description: Vat type id value: type: number description: '[Read Only] Vat type percentual value' example: 22 maximum: 100 minimum: 0 description: type: string description: Vat type short description example: Non imponibile art. 123 notes: type: string description: Vat type notes shown in documents example: IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: type: boolean description: Vat type is usable for e-invoices ei_type: type: string description: Vat type e-invoice type (natura) example: 2 ei_description: type: string description: Vat type e-invoice description editable: type: boolean description: |- [Read Only] Is the vat type is editable. readOnly: true default: true is_disabled: type: boolean description: Is the vat type disabled required: - value examples: example-1: value: data: id: 0 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: true ei_type: 2 ei_description: string editable: true is_disabled: true delete: summary: Delete Vat Type tags: - Settings responses: '200': description: OK operationId: deleteVatType description: Deletes the specified vat type. security: - OAuth2AuthenticationCodeFlow: - settings:a - ManualAuth: [] /c/{company_id}/issued_documents/transform: get: summary: Transform Issued Document tags: - Issued Documents responses: '200': $ref: '#/components/responses/TransformIssuedDocumentResponse' operationId: transformIssuedDocument description: Transforms the document. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: - schema: type: integer in: query name: original_document_id required: true description: Original document id. - schema: type: string in: query name: new_type description: New document type. required: true - schema: type: integer enum: - 0 - 1 in: query name: e_invoice description: New document e_invoice. - schema: type: integer enum: - 0 - 1 in: query name: transform_keep_copy description: Keep the old document. parameters: - $ref: '#/components/parameters/company_id' /c/{company_id}/issued_documents/join: get: summary: Join Issued Documents tags: - Issued Documents responses: '200': $ref: '#/components/responses/JoinIssuedDocumentsResponse' operationId: joinIssuedDocuments description: Joins issued documents. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] parameters: - schema: type: string example: 1,2,3,4 in: query name: ids required: true description: Ids of the documents. - schema: type: integer enum: - 0 - 1 in: query name: group description: Group items. - schema: type: integer enum: - 0 - 1 in: query name: e_invoice description: New document e_invoice. parameters: - $ref: '#/components/parameters/company_id' /c/{company_id}/emails: parameters: - $ref: '#/components/parameters/company_id' get: summary: List Emails tags: - Emails responses: '200': $ref: '#/components/responses/ListEmailsResponse' operationId: listEmails description: List Emails. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] /c/{company_id}/subscriptions: get: summary: List Webhooks Subscriptions tags: - Webhooks responses: '200': $ref: '#/components/responses/ListWebhooksSubscriptionsResponse' operationId: listWebhooksSubscriptions description: List active webhooks subscriptions. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] post: summary: Create a Webhook Subscription responses: '200': $ref: '#/components/responses/CreateWebhooksSubscriptionResponse' operationId: CreateWebhooksSubscription requestBody: content: application/json: schema: title: CreateWebhooksSubscriptionRequest type: object properties: data: title: WebhooksSubscription type: object properties: id: type: string description: Webhooks subscription id sink: type: string description: Webhooks callback uri. verified: type: boolean description: >- [Read Only] True if the webhooks subscription has been verified. types: type: array description: Webhooks events types. items: type: string title: EventType description: Webhooks event type enum: - >- it.fattureincloud.webhooks.issued_documents.invoices.create - >- it.fattureincloud.webhooks.issued_documents.invoices.update - >- it.fattureincloud.webhooks.issued_documents.invoices.delete - >- it.fattureincloud.webhooks.issued_documents.quotes.create - >- it.fattureincloud.webhooks.issued_documents.quotes.update - >- it.fattureincloud.webhooks.issued_documents.quotes.delete - >- it.fattureincloud.webhooks.issued_documents.proformas.create - >- it.fattureincloud.webhooks.issued_documents.proformas.update - >- it.fattureincloud.webhooks.issued_documents.proformas.delete - >- it.fattureincloud.webhooks.issued_documents.receipts.create - >- it.fattureincloud.webhooks.issued_documents.receipts.update - >- it.fattureincloud.webhooks.issued_documents.receipts.delete - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.create - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.update - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.delete - >- it.fattureincloud.webhooks.issued_documents.credit_notes.create - >- it.fattureincloud.webhooks.issued_documents.credit_notes.update - >- it.fattureincloud.webhooks.issued_documents.credit_notes.delete - >- it.fattureincloud.webhooks.issued_documents.orders.create - >- it.fattureincloud.webhooks.issued_documents.orders.update - >- it.fattureincloud.webhooks.issued_documents.orders.delete - >- it.fattureincloud.webhooks.issued_documents.work_reports.create - >- it.fattureincloud.webhooks.issued_documents.work_reports.update - >- it.fattureincloud.webhooks.issued_documents.work_reports.delete - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.create - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.update - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.delete - >- it.fattureincloud.webhooks.issued_documents.self_invoices.create - >- it.fattureincloud.webhooks.issued_documents.self_invoices.update - >- it.fattureincloud.webhooks.issued_documents.self_invoices.delete - >- it.fattureincloud.webhooks.issued_documents.all.create - >- it.fattureincloud.webhooks.issued_documents.all.update - >- it.fattureincloud.webhooks.issued_documents.all.delete - it.fattureincloud.webhooks.received_documents.create - it.fattureincloud.webhooks.received_documents.update - it.fattureincloud.webhooks.received_documents.delete - it.fattureincloud.webhooks.receipts.create - it.fattureincloud.webhooks.receipts.update - it.fattureincloud.webhooks.receipts.delete - it.fattureincloud.webhooks.taxes.create - it.fattureincloud.webhooks.taxes.update - it.fattureincloud.webhooks.taxes.delete - it.fattureincloud.webhooks.archive_documents.create - it.fattureincloud.webhooks.archive_documents.update - it.fattureincloud.webhooks.archive_documents.delete - it.fattureincloud.webhooks.cashbook.create - it.fattureincloud.webhooks.cashbook.update - it.fattureincloud.webhooks.cashbook.delete - it.fattureincloud.webhooks.products.create - it.fattureincloud.webhooks.products.update - it.fattureincloud.webhooks.products.delete - it.fattureincloud.webhooks.products.stock_update - it.fattureincloud.webhooks.entities.clients.create - it.fattureincloud.webhooks.entities.clients.update - it.fattureincloud.webhooks.entities.clients.delete - it.fattureincloud.webhooks.entities.suppliers.create - it.fattureincloud.webhooks.entities.suppliers.update - it.fattureincloud.webhooks.entities.suppliers.delete - it.fattureincloud.webhooks.entities.all.create - it.fattureincloud.webhooks.entities.all.update - it.fattureincloud.webhooks.entities.all.delete - >- it.fattureincloud.webhooks.issued_documents.e_invoices.status_update - >- it.fattureincloud.webhooks.received_documents.e_invoices.receive config: title: WebhooksSubscriptionConfig type: object properties: mapping: title: WebhooksSubscriptionMapping type: string description: Determines the webhook payload shape enum: - binary - structured default: binary examples: example-1: value: data: sink: http://www.test.com types: - it.fattureincloud.webhooks.entities.create - it.fattureincloud.webhooks.issued_documents.create description: '' description: Register some webhooks Subscriptions. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] tags: - Webhooks parameters: - $ref: '#/components/parameters/company_id' /c/{company_id}/subscriptions/{subscription_id}: parameters: - $ref: '#/components/parameters/company_id' - $ref: '#/components/parameters/subscription_id' get: summary: Get Webhooks Subscription tags: - Webhooks responses: '200': $ref: '#/components/responses/GetWebhooksSubscriptionResponse' operationId: getWebhooksSubscription description: Get a webhooks subscription. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] put: summary: Modify Webhooks Subscription tags: - Webhooks responses: '200': $ref: '#/components/responses/ModifyWebhooksSubscriptionResponse' operationId: modifyWebhooksSubscription description: Edit a webhooks subscription. requestBody: content: application/json: schema: title: ModifyWebhooksSubscriptionRequest type: object properties: data: title: WebhooksSubscription type: object properties: id: type: string description: Webhooks subscription id sink: type: string description: Webhooks callback uri. verified: type: boolean description: >- [Read Only] True if the webhooks subscription has been verified. types: type: array description: Webhooks events types. items: type: string title: EventType description: Webhooks event type enum: - >- it.fattureincloud.webhooks.issued_documents.invoices.create - >- it.fattureincloud.webhooks.issued_documents.invoices.update - >- it.fattureincloud.webhooks.issued_documents.invoices.delete - >- it.fattureincloud.webhooks.issued_documents.quotes.create - >- it.fattureincloud.webhooks.issued_documents.quotes.update - >- it.fattureincloud.webhooks.issued_documents.quotes.delete - >- it.fattureincloud.webhooks.issued_documents.proformas.create - >- it.fattureincloud.webhooks.issued_documents.proformas.update - >- it.fattureincloud.webhooks.issued_documents.proformas.delete - >- it.fattureincloud.webhooks.issued_documents.receipts.create - >- it.fattureincloud.webhooks.issued_documents.receipts.update - >- it.fattureincloud.webhooks.issued_documents.receipts.delete - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.create - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.update - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.delete - >- it.fattureincloud.webhooks.issued_documents.credit_notes.create - >- it.fattureincloud.webhooks.issued_documents.credit_notes.update - >- it.fattureincloud.webhooks.issued_documents.credit_notes.delete - >- it.fattureincloud.webhooks.issued_documents.orders.create - >- it.fattureincloud.webhooks.issued_documents.orders.update - >- it.fattureincloud.webhooks.issued_documents.orders.delete - >- it.fattureincloud.webhooks.issued_documents.work_reports.create - >- it.fattureincloud.webhooks.issued_documents.work_reports.update - >- it.fattureincloud.webhooks.issued_documents.work_reports.delete - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.create - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.update - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.delete - >- it.fattureincloud.webhooks.issued_documents.self_invoices.create - >- it.fattureincloud.webhooks.issued_documents.self_invoices.update - >- it.fattureincloud.webhooks.issued_documents.self_invoices.delete - >- it.fattureincloud.webhooks.issued_documents.all.create - >- it.fattureincloud.webhooks.issued_documents.all.update - >- it.fattureincloud.webhooks.issued_documents.all.delete - it.fattureincloud.webhooks.received_documents.create - it.fattureincloud.webhooks.received_documents.update - it.fattureincloud.webhooks.received_documents.delete - it.fattureincloud.webhooks.receipts.create - it.fattureincloud.webhooks.receipts.update - it.fattureincloud.webhooks.receipts.delete - it.fattureincloud.webhooks.taxes.create - it.fattureincloud.webhooks.taxes.update - it.fattureincloud.webhooks.taxes.delete - it.fattureincloud.webhooks.archive_documents.create - it.fattureincloud.webhooks.archive_documents.update - it.fattureincloud.webhooks.archive_documents.delete - it.fattureincloud.webhooks.cashbook.create - it.fattureincloud.webhooks.cashbook.update - it.fattureincloud.webhooks.cashbook.delete - it.fattureincloud.webhooks.products.create - it.fattureincloud.webhooks.products.update - it.fattureincloud.webhooks.products.delete - it.fattureincloud.webhooks.products.stock_update - it.fattureincloud.webhooks.entities.clients.create - it.fattureincloud.webhooks.entities.clients.update - it.fattureincloud.webhooks.entities.clients.delete - it.fattureincloud.webhooks.entities.suppliers.create - it.fattureincloud.webhooks.entities.suppliers.update - it.fattureincloud.webhooks.entities.suppliers.delete - it.fattureincloud.webhooks.entities.all.create - it.fattureincloud.webhooks.entities.all.update - it.fattureincloud.webhooks.entities.all.delete - >- it.fattureincloud.webhooks.issued_documents.e_invoices.status_update - >- it.fattureincloud.webhooks.received_documents.e_invoices.receive config: title: WebhooksSubscriptionConfig type: object properties: mapping: title: WebhooksSubscriptionMapping type: string description: Determines the webhook payload shape enum: - binary - structured default: binary security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] delete: summary: Delete Webhooks Subscription tags: - Webhooks responses: '200': description: OK operationId: deleteWebhooksSubscription description: Delete a webhooks subscription. security: - OAuth2AuthenticationCodeFlow: [] - ManualAuth: [] components: schemas: {} securitySchemes: OAuth2AuthenticationCodeFlow: type: oauth2 x-receive-token-in: request-body flows: authorizationCode: tokenUrl: https://api-v2.fattureincloud.it/oauth/token refreshUrl: https://api-v2.fattureincloud.it/oauth/token scopes: entity.clients:r: Read permission to the Clients registry entity.clients:a: Write permission to the Clients registry entity.suppliers:r: Read permission to the Suppliers registry entity.suppliers:a: Write permission to the Suppliers registry products:r: Read permission to the Products products:a: Write permission to the Products issued_documents.invoices:r: Read permission to the issued Invoices issued_documents.credit_notes:r: Read permission to the issued Credit Notes issued_documents.receipts:r: Read permission to the issued Receipts issued_documents.orders:r: Read permission to the issued Orders issued_documents.quotes:r: Read permission to the issued Quotes issued_documents.proformas:r: Read permission to the issued Proformas issued_documents.delivery_notes:r: Read permission to the issued Delivery Notes issued_documents.work_reports:r: Read permission to the issued Work Reports issued_documents.supplier_orders:r: Read permission to the issued Supplier Orders issued_documents.self_invoices:r: Read permission to the issued Self Invoices issued_documents.invoices:a: Write permission to the issued Invoices issued_documents.credit_notes:a: Write permission to the issued Credit Notes issued_documents.receipts:a: Write permission to the issued issued Receipts issued_documents.orders:a: Write permission to the issued Orders issued_documents.quotes:a: Write permission to the issued Quotes issued_documents.proformas:a: Write permission to the issued Proformas issued_documents.delivery_notes:a: Write permission to the issued Delivery Notes issued_documents.work_reports:a: Write permission to the issued Work Reports issued_documents.supplier_orders:a: Write permission to the issued Supplier Orders issued_documents.self_invoices:a: Write permission to the issued Self Invoices received_documents:r: Read permission to the Received Documents received_documents:a: Write permission to the Received Documents stock:r: Read permission to the Stock movements stock:a: Write permission to the Stock movements receipts:r: Read permission to the Receipts receipts:a: Write permission to the Receipts taxes:r: Read permission to the Taxes taxes:a: Write permission to the Taxes archive:r: Read permission to the Archive Documents archive:a: Read permission to the Archive Documents cashbook:r: Read permission to the Cashbook cashbook:a: Write permission to the Cashbook settings:r: Read permission to the Settings settings:a: Write permission to the Settings situation:r: Read permission to the company Situation authorizationUrl: https://api-v2.fattureincloud.it/oauth/authorize ManualAuth: type: http scheme: bearer parameters: company_id: name: company_id in: path required: true schema: type: integer example: '12345' description: The ID of the company. fieldset: name: fieldset in: query required: false schema: type: string enum: - basic - detailed description: Name of the fieldset. sort: name: sort in: query required: false schema: type: string description: >- List of comma-separated fields for result sorting (minus for desc sorting). fields: name: fields in: query required: false schema: type: string description: List of comma-separated fields. page: name: page in: query required: false schema: type: integer default: 1 description: The page to retrieve. client_id: name: client_id in: path required: true schema: type: integer description: The ID of the client. supplier_id: name: supplier_id in: path required: true schema: type: integer description: The ID of the supplier. product_id: name: product_id in: path required: true schema: type: integer description: The ID of the product. issued_document_type: name: type in: query required: true schema: type: string enum: - invoice - quote - proforma - receipt - delivery_note - credit_note - order - work_report - supplier_order - self_own_invoice - self_supplier_invoice description: The type of the issued document. per_page: name: per_page in: query required: false schema: type: integer default: 5 minimum: 1 maximum: 100 description: The size of the page. document_id: name: document_id in: path required: true schema: type: integer description: The ID of the document. received_document_type: name: type in: query required: true schema: type: string enum: - expense - passive_credit_note - passive_delivery_note description: The type of the received document. q: name: q in: query required: false schema: type: string description: Query for filtering the results. include_attachment: name: include_attachment in: query required: false schema: type: boolean description: Include the attachment to the XML e-invoice. subscription_id: name: subscription_id in: path required: true schema: type: string example: SUB123 description: The ID of the subscription. responses: GetUserInfoResponse: description: '' content: application/json: schema: title: GetUserInfoResponse type: object description: '' properties: data: type: object title: User properties: id: type: integer example: 12345 description: User id nullable: true name: type: string nullable: true description: User full name example: Mario Rossi first_name: type: string nullable: true example: Mario description: User first name last_name: type: string nullable: true example: Rossi description: User last name email: type: string nullable: true example: mario.rossi@example.com description: User email address hash: type: string example: 5add29e1234532a1bf2ed7b612043029 nullable: true description: User hash picture: type: string nullable: true example: picture.jpg description: User picture nullable: true info: type: object properties: need_marketing_consents_confirmation: type: boolean nullable: true need_password_change: type: boolean nullable: true need_terms_of_service_confirmation: type: boolean nullable: true nullable: true email_confirmation_state: type: object properties: need_confirmation: type: boolean nullable: true nullable: true examples: example-1: value: data: id: 12345 name: Mario Rossi first_name: Mario last_name: Rossi email: mario.rossi@example.com hash: 5add29e1234532a1bf2ed7b612043029 picture: picture.jpg info: need_marketing_consents_confirmation: false need_password_change: false need_terms_of_service_confirmation: false email_confirmation_state: need_confirmation: false ListUserCompaniesResponse: description: User Companies. content: application/json: schema: title: ListUserCompaniesResponse type: object description: '' properties: data: type: object properties: companies: type: array items: type: object title: Company properties: id: type: integer description: Company id example: 12345 nullable: true name: type: string description: Company name example: Rossi S.r.l. nullable: true type: title: CompanyType type: string description: Company type enum: - company - accountant access_token: type: string description: |- Company authentication token for this company. [Only if type=company] example: >- fd015011d2dbf8a9d38e810b325b11b56d02e51688e5261a245933b8e677b8b44ff5f0fe5ccaaf1d7157fa13ca72ab62b6183db0667a576a0e19164801c18c4fd81273fc1f95bf460b869015cf99acba nullable: true controlled_companies: type: array description: |- Company list of controlled companies [Only if type=accountant] nullable: true items: type: object title: Controlled Company properties: id: type: integer description: Controlled company id example: 12345 nullable: true name: type: string description: Controlled company id example: Rossi S.r.l. nullable: true type: title: CompanyType type: string description: Company type enum: - company - accountant access_token: type: string description: |- Controlled company access token Only if type=company] example: >- fd015011d2dbf8a9d38e810b325b11b56d02e51688e5261a245933b8e677b8b44ff5f0fe5ccaaf1d7157fa13ca72ab62b6183db0667a576a0e19164801c18c4fd81273fc1f95bf460b869015cf99acba nullable: true fic_license_expire: type: string format: date nullable: true fic_plan: title: FattureInCloudPlanType type: string description: Fatture in Cloud account plan type. enum: - trial - standard - premium - premium_plus - complete connection_id: type: number description: Controlled company connection id nullable: true tax_code: type: string description: Controlled company tax code nullable: true fic_license_expire: type: string format: date nullable: true fic_plan: title: FattureInCloudPlanType type: string description: Fatture in Cloud account plan type. enum: - trial - standard - premium - premium_plus - complete connection_id: type: integer description: Company connection id nullable: true tax_code: type: string description: Company tax code nullable: true vat_number: type: string description: Company vat number nullable: true nullable: true nullable: true examples: example-1: value: data: companies: - id: 12345 name: Studio Commercialista tax_code: ABCSFN94T17A794K vat_number: 3881520161 type: accountant access_token: >- 4ff5f0fe5abcd1d7157fa13ca72ab62b6183db0667a576a0e19164801c18c4f7362a848fa32dbb8c3a3f94c34f3df95 connection_id: 94566 controlled_companies: - id: 12246 name: Studio Commercialista tax_code: ABCSFN94T17A794K vat_number: 3881520161 type: company access_token: >- 4ff5f0fe5abcdf1d7157fa13ca72ab62b6183db0667a576a0e19164801c18c4f7362a848fa32dbb8c3a3f94c34f3df95 connection_id: 94566 controlled_companies: [] fic: true dic: true fic_plan: premium_plus fic_license_expire: '2021-12-31' permissions: fic_situation: write fic_clients: write fic_suppliers: write fic_products: write fic_issued_documents: write fic_received_documents: write fic_receipts: write fic_calendar: write fic_archive: write fic_taxes: write fic_stock: write fic_cashbook: write fic_settings: write fic_emails: write dic_employees: write dic_timesheet: write dic_settings: write - id: 12347 name: Mario Rossi SRL tax_code: '57398280214' type: company access_token: >- 86690c98be13592e78b763c52fab2ba0c22faa118708ca5273da2b4dcdc7ad1234517107266d463fd9ae424a78c16cde connection_id: 94566 controlled_companies: [] fic: true dic: false fic_plan: trial fic_license_expire: '2021-12-31' permissions: fic_situation: write fic_clients: write fic_suppliers: write fic_products: write fic_issued_documents: write fic_received_documents: write fic_receipts: write fic_calendar: write fic_archive: write fic_taxes: write fic_stock: write fic_cashbook: write fic_settings: write fic_emails: write dic_employees: none dic_timesheet: none dic_settings: none GetCompanyInfoResponse: description: Company info. content: application/json: schema: title: GetCompanyInfoResponse description: '' type: object properties: data: type: object title: CompanyInfo properties: id: type: integer description: Company id example: 12345 nullable: true name: type: string description: Company name example: Mario Rossi S.r.l. nullable: true email: type: string description: Company email example: mario@rossi-example.it nullable: true type: title: CompanyType type: string description: Company type enum: - company - accountant access_info: type: object nullable: true properties: role: title: UserCompanyRole type: string description: User company role enum: - master - subaccount - employee permissions: type: object description: '' properties: fic_situation: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_clients: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_suppliers: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_products: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_issued_documents: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_received_documents: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_receipts: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_calendar: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_archive: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_taxes: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_stock: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_cashbook: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_settings: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_emails: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_export: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_import_bankstatements: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_import_clients_suppliers: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_import_issued_documents: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_import_products: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_recurring: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_riba: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true dic_employees: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true dic_settings: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true dic_timesheet: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true fic_issued_documents_detailed: type: object properties: quotes: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true proformas: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true invoices: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true receipts: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true delivery_notes: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true credit_notes: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true orders: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true work_reports: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true supplier_orders: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true self_invoices: title: PermissionLevel type: string enum: - none - read - write - detailed description: Permission level nullable: true nullable: true title: Permissions through_accountant: type: boolean nullable: true description: Company activated through accountant fic_license_expire: type: string format: date nullable: true fic_plan_name: title: FattureInCloudPlanType type: string description: Fatture in Cloud account plan type. enum: - trial - standard - premium - premium_plus - complete plan_info: type: object nullable: true description: Company plan info properties: limits: type: object description: Company plan limits nullable: true properties: clients: type: integer nullable: true description: Company plan clients limits suppliers: type: integer nullable: true description: Company plan suppliers limits products: type: integer nullable: true description: Company plan products limits documents: type: integer nullable: true description: Company plan documents limits functions: type: object description: Access to functions for this company. nullable: true properties: archive: type: boolean nullable: true cerved: type: boolean nullable: true document_attachments: type: boolean nullable: true e_invoice: type: boolean nullable: true genius: type: boolean nullable: true mail_tracking: type: boolean nullable: true payment_notifications: type: boolean nullable: true paypal: type: boolean nullable: true receipts: type: boolean nullable: true recurring: type: boolean nullable: true smtp: type: boolean nullable: true sofort: type: boolean nullable: true stock: type: boolean nullable: true subaccounts: type: boolean nullable: true tessera_sanitaria: type: boolean nullable: true ts_digital: type: boolean nullable: true ts_invoice_trading: type: boolean nullable: true ts_pay: type: boolean nullable: true functions_status: type: object nullable: true properties: ts_digital: title: FunctionStatus type: object properties: active: type: boolean nullable: true ts_pay: title: FunctionStatus type: object properties: active: type: boolean nullable: true accountant_id: type: integer nullable: true description: Company accountant id is_accountant: type: boolean description: Is the logged account an accountant. nullable: true nullable: true examples: example-1: value: data: id: 12345 name: Studio Commercialista email: mario.rossi@example.com type: accountant fic: true fic_plan_name: premium_plus fic_signup_date: '2013-11-01' fic_license_expire: '2030-12-31' use_fic: true fic_need_setup: false fic_license_type: coupon_b dic: true dic_plan_name: trial dic_signup_date: '2018-03-26' dic_license_expire: '2022-12-31' use_dic: true dic_license_type: null registration_service: fic can_use_coupon: false access_info: role: master through_accountant: false permissions: fic_situation: read fic_clients: write fic_suppliers: write fic_products: write fic_issued_documents: detailed fic_issued_documents_detailed: quotes: write proformas: write invoices: write receipts: write delivery_notes: write credit_notes: write orders: write work_reports: write supplier_orders: write self_invoices: write fic_received_documents: write fic_receipts: write fic_calendar: write fic_archive: write fic_taxes: write fic_stock: write fic_cashbook: write fic_settings: write fic_emails: read dic_employees: none dic_timesheet: none dic_settings: none fic_invoice_trading: none fic_export: write fic_import_clients_suppliers: write fic_import_products: write fic_import_issued_documents: none fic_import_bankstatements: none fic_recurring: write fic_riba: write plan_info: limits: clients: 5000 suppliers: 5000 products: 5000 documents: 3000 functions: document_attachments: true archive: true payment_notifications: true paypal: true receipts: true e_invoice: true genius: true stock: true smtp: true mail_tracking: true subaccounts: true tessera_sanitaria: true recurring: true sofort: false cerved: true ts_digital: true ts_pay: true ts_invoice_trading: true functions_status: ts_digital: active: true ts_pay: active: true is_accountant: true accountant_id: 12345 fic_payment_subject: client dic_payment_subject: client CreateClientResponse: description: Example response content: application/json: schema: title: CreateClientResponse type: object properties: data: type: object title: Client properties: id: type: integer description: Client id nullable: true code: type: string example: '123' description: Client code nullable: true name: type: string example: Rossi S.r.l. description: Client name nullable: true type: title: ClientType type: string nullable: true default: null enum: - company - person - pa - condo description: Client type first_name: type: string description: Client first name nullable: true last_name: type: string description: Client last name nullable: true contact_person: type: string nullable: true description: Client contact person vat_number: type: string example: IT01234567890 description: Client vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Client tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Client address street nullable: true address_postal_code: type: string example: '24010' description: Client address postal code nullable: true address_city: type: string example: Bergamo description: Client address city nullable: true address_province: type: string example: BG description: Client address province nullable: true address_extra: type: string description: Client address extra info nullable: true country: type: string example: Italia description: Client country nullable: true country_iso: type: string example: Italia description: Client country iso code nullable: true email: type: string example: mario.rossi@example.it description: Client email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Client certified email nullable: true phone: type: string description: Client phone nullable: true fax: type: string description: Client fax nullable: true notes: type: string description: Client extra nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true default_payment_terms: type: integer example: 30 nullable: true description: Client default payment terms default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true bank_name: type: string description: Client bank name nullable: true bank_iban: type: string description: Client bank iban nullable: true bank_swift_code: type: string description: Client bank swift code nullable: true shipping_address: type: string description: Client shipping address nullable: true e_invoice: type: boolean description: Use e-invoices for this entity nullable: true ei_code: type: string description: | Client e-invoice code nullable: true discount_highlight: type: boolean description: Highlight Discount nullable: true default_discount: type: number description: Client default discount nullable: true has_intent_declaration: type: boolean description: Client has intent declaration nullable: true intent_declaration_protocol_number: type: string description: Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Client creation date updated_at: type: string nullable: true description: Client last update date nullable: true examples: example-1: value: data: id: 16451 code: AE86 name: Avv. Maria Rossi type: person first_name: Maria last_name: Rossi contact_person: '' vat_number: IT12345640962 tax_code: BLTGNI5ABCDA794E address_street: Via Roma, 1 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia email: maria.rossi@example.com certified_email: maria.rossi@pec.example.com phone: '1234567890' fax: '' notes: '' created_at: '2021-04-29 08:53:07' updated_at: '2021-04-29 08:53:07' default_payment_terms: 1 default_payment_terms_type: standard bank_name: Indesa bank_iban: IT40P123456781000000123456 bank_swift_code: AK86PCT shipping_address: Corso Magellano 4 e_invoice: true ei_code: '111111' default_vat: id: 54321 value: 45 description: '' is_disabled: false default_payment_method: id: 386092 name: Credit card ListClientsResponse: description: Example response content: application/json: schema: title: ListClientsResponse allOf: - title: Pagination type: object description: '' properties: current_page: type: integer description: Current page number. nullable: true first_page_url: type: string format: uri description: First page url. nullable: true from: type: integer nullable: true description: First result of the page. last_page: type: integer description: Last page number. nullable: true last_page_url: type: string format: uri description: Last page url. nullable: true next_page_url: type: string format: uri nullable: true description: Next page url path: type: string format: uri description: Request path. nullable: true per_page: type: integer description: Number of result per page. nullable: true prev_page_url: type: string format: uri nullable: true description: Previous page url. to: type: integer nullable: true description: Last result of the page. total: type: integer description: Total number of results nullable: true - title: ListClientsResponsePage type: object properties: data: type: array items: type: object title: Client properties: id: type: integer description: Client id nullable: true code: type: string example: '123' description: Client code nullable: true name: type: string example: Rossi S.r.l. description: Client name nullable: true type: title: ClientType type: string nullable: true default: null enum: - company - person - pa - condo description: Client type first_name: type: string description: Client first name nullable: true last_name: type: string description: Client last name nullable: true contact_person: type: string nullable: true description: Client contact person vat_number: type: string example: IT01234567890 description: Client vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Client tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Client address street nullable: true address_postal_code: type: string example: '24010' description: Client address postal code nullable: true address_city: type: string example: Bergamo description: Client address city nullable: true address_province: type: string example: BG description: Client address province nullable: true address_extra: type: string description: Client address extra info nullable: true country: type: string example: Italia description: Client country nullable: true country_iso: type: string example: Italia description: Client country iso code nullable: true email: type: string example: mario.rossi@example.it description: Client email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Client certified email nullable: true phone: type: string description: Client phone nullable: true fax: type: string description: Client fax nullable: true notes: type: string description: Client extra nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true default_payment_terms: type: integer example: 30 nullable: true description: Client default payment terms default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true bank_name: type: string description: Client bank name nullable: true bank_iban: type: string description: Client bank iban nullable: true bank_swift_code: type: string description: Client bank swift code nullable: true shipping_address: type: string description: Client shipping address nullable: true e_invoice: type: boolean description: Use e-invoices for this entity nullable: true ei_code: type: string description: | Client e-invoice code nullable: true discount_highlight: type: boolean description: Highlight Discount nullable: true default_discount: type: number description: Client default discount nullable: true has_intent_declaration: type: boolean description: Client has intent declaration nullable: true intent_declaration_protocol_number: type: string description: Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Client creation date updated_at: type: string nullable: true description: Client last update date nullable: true examples: example-1: value: current_page: 1 data: - id: 16451 code: AE86 name: Avv. Maria Rossi type: person first_name: Maria last_name: Rossi contact_person: '' vat_number: IT12345640962 tax_code: BLTGNI5ABCDA794E address_street: Via Roma, 1 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia email: maria.rossi@example.com certified_email: maria.rossi@pec.example.com phone: '1234567890' fax: '' notes: '' created_at: '2021-04-29 08:53:07' updated_at: '2021-04-29 08:53:07' default_payment_terms: 1 default_payment_terms_type: standard bank_name: Indesa bank_iban: IT40P123456781000000123456 bank_swift_code: AK86PCT shipping_address: Corso Magellano 4 e_invoice: true ei_code: '111111' default_vat: id: 54321 value: 45 description: '' is_disabled: false default_payment_method: id: 386092 name: Credit card - id: 25330696 code: PD00 name: Mario Rossi type: person first_name: Mario last_name: Rossi contact_person: '' vat_number: IT1234567890 tax_code: ABCDEF12G34H567I address_street: Via largo augusto 123 address_postal_code: '21012' address_city: Bergamo address_province: BG address_extra: '' country: Italia email: info@mariorossi.it certified_email: info@pec.mariorossi.it phone: '012345678' fax: '012345678' notes: '' created_at: '2021-04-29 08:53:07' default_payment_terms: 0 default_payment_terms_type: standard bank_name: Monte dei Pascoli bank_iban: IT00P123456781000000123456 bank_swift_code: APL86PCT shipping_address: Via Miilano 4 e_invoice: false ei_code: '7654321' default_vat: id: 66 value: 22 description: '' is_disabled: false default_payment_method: null first_page_url: page=1 from: 1 last_page: 2 last_page_url: page=2 next_page_url: page=2 path: entities/clients per_page: 5 prev_page_url: null to: 50 total: 8 ListSuppliersResponse: description: Example response content: application/json: schema: title: ListSuppliersResponse allOf: - title: Pagination type: object description: '' properties: current_page: type: integer description: Current page number. nullable: true first_page_url: type: string format: uri description: First page url. nullable: true from: type: integer nullable: true description: First result of the page. last_page: type: integer description: Last page number. nullable: true last_page_url: type: string format: uri description: Last page url. nullable: true next_page_url: type: string format: uri nullable: true description: Next page url path: type: string format: uri description: Request path. nullable: true per_page: type: integer description: Number of result per page. nullable: true prev_page_url: type: string format: uri nullable: true description: Previous page url. to: type: integer nullable: true description: Last result of the page. total: type: integer description: Total number of results nullable: true - title: ListSuppliersResponsePage type: object properties: data: type: array items: type: object title: Supplier properties: id: type: integer description: Supplier id nullable: true code: type: string example: '123' description: Supplier code nullable: true name: type: string example: Rossi S.r.l. description: Supplier name nullable: true type: title: SupplierType type: string nullable: true default: null enum: - company - person - pa - condo description: Supplier type first_name: type: string description: Supplier first name nullable: true last_name: type: string description: Supplier last name nullable: true contact_person: type: string nullable: true description: Supplier contact person vat_number: type: string example: IT01234567890 description: Supplier vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Supplier tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Supplier street address nullable: true address_postal_code: type: string example: '24010' description: Supplier postal code nullable: true address_city: type: string example: Bergamo description: Supplier city nullable: true address_province: type: string example: BG description: Supplier province nullable: true address_extra: type: string description: Supplier address extra info nullable: true country: type: string example: Italia description: Supplier country nullable: true country_iso: type: string example: Italia description: Supplier country iso code nullable: true email: type: string example: mario.rossi@example.it description: Supplier email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Supplier certified email nullable: true phone: type: string description: Supplier phone nullable: true fax: type: string description: Supplier fax nullable: true notes: type: string description: Supplier extra notes nullable: true bank_iban: type: string description: Supplier bank IBAN nullable: true created_at: type: string nullable: true description: Supplier creation date updated_at: type: string nullable: true description: Supplier last update date nullable: true examples: example-1: value: first_page_url: page=1 from: 1 last_page: 2 last_page_url: page=2 next_page_url: page=2 path: /entities/suppliers per_page: 50 prev_page_url: null to: 55 total: 55 data: - id: 12345 code: AE86 name: Mario Rossi S.R.L. type: company first_name: Mario last_name: Rossi contact_person: '' vat_number: '111222333' tax_code: '111122233' address_street: Corso Magellano, 46 address_postal_code: '20146' address_city: Milano address_province: MI address_extra: '' country: Italia email: mario.rossi@example.com certified_email: mario.rossi@pec.example.com phone: '1234567890' fax: '123456789' notes: '' created_at: '2021-15-08' updated_at: '2021-15-08' - id: 12346 code: GT86 name: Maria Grossi S.R.L. type: company first_name: '' last_name: '' contact_person: '' vat_number: '200020102020' tax_code: '200020102020' address_street: Vicolo stretto, 32 address_postal_code: '20146' address_city: Milano address_province: MI address_extra: '' country: Italia email: maria.grossi@example.com certified_email: maria.grossi@pec.example.com phone: '0987654321' fax: '098765432' notes: '' created_at: '2021-15-09' updated_at: '2021-15-09' CreateSupplierResponse: description: Example response content: application/json: schema: title: CreateSupplierResponse type: object properties: data: type: object title: Supplier properties: id: type: integer description: Supplier id nullable: true code: type: string example: '123' description: Supplier code nullable: true name: type: string example: Rossi S.r.l. description: Supplier name nullable: true type: title: SupplierType type: string nullable: true default: null enum: - company - person - pa - condo description: Supplier type first_name: type: string description: Supplier first name nullable: true last_name: type: string description: Supplier last name nullable: true contact_person: type: string nullable: true description: Supplier contact person vat_number: type: string example: IT01234567890 description: Supplier vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Supplier tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Supplier street address nullable: true address_postal_code: type: string example: '24010' description: Supplier postal code nullable: true address_city: type: string example: Bergamo description: Supplier city nullable: true address_province: type: string example: BG description: Supplier province nullable: true address_extra: type: string description: Supplier address extra info nullable: true country: type: string example: Italia description: Supplier country nullable: true country_iso: type: string example: Italia description: Supplier country iso code nullable: true email: type: string example: mario.rossi@example.it description: Supplier email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Supplier certified email nullable: true phone: type: string description: Supplier phone nullable: true fax: type: string description: Supplier fax nullable: true notes: type: string description: Supplier extra notes nullable: true bank_iban: type: string description: Supplier bank IBAN nullable: true created_at: type: string nullable: true description: Supplier creation date updated_at: type: string nullable: true description: Supplier last update date nullable: true examples: example-1: value: data: id: 12345 code: AE86 name: Mario Rossi S.R.L. type: company first_name: Mario last_name: Rossi contact_person: '' vat_number: '111222333' tax_code: '111122233' address_street: Corso Magellano, 46 address_postal_code: '20146' address_city: Milano address_province: MI address_extra: '' country: Italia email: mario.rossi@example.com certified_email: mario.rossi@pec.example.com phone: '1234567890' fax: '123456789' notes: '' created_at: '2021-15-08' updated_at: '2021-15-08' GetClientResponse: description: Client Details. content: application/json: schema: title: GetClientResponse type: object properties: data: type: object title: Client properties: id: type: integer description: Client id nullable: true code: type: string example: '123' description: Client code nullable: true name: type: string example: Rossi S.r.l. description: Client name nullable: true type: title: ClientType type: string nullable: true default: null enum: - company - person - pa - condo description: Client type first_name: type: string description: Client first name nullable: true last_name: type: string description: Client last name nullable: true contact_person: type: string nullable: true description: Client contact person vat_number: type: string example: IT01234567890 description: Client vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Client tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Client address street nullable: true address_postal_code: type: string example: '24010' description: Client address postal code nullable: true address_city: type: string example: Bergamo description: Client address city nullable: true address_province: type: string example: BG description: Client address province nullable: true address_extra: type: string description: Client address extra info nullable: true country: type: string example: Italia description: Client country nullable: true country_iso: type: string example: Italia description: Client country iso code nullable: true email: type: string example: mario.rossi@example.it description: Client email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Client certified email nullable: true phone: type: string description: Client phone nullable: true fax: type: string description: Client fax nullable: true notes: type: string description: Client extra nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true default_payment_terms: type: integer example: 30 nullable: true description: Client default payment terms default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true bank_name: type: string description: Client bank name nullable: true bank_iban: type: string description: Client bank iban nullable: true bank_swift_code: type: string description: Client bank swift code nullable: true shipping_address: type: string description: Client shipping address nullable: true e_invoice: type: boolean description: Use e-invoices for this entity nullable: true ei_code: type: string description: | Client e-invoice code nullable: true discount_highlight: type: boolean description: Highlight Discount nullable: true default_discount: type: number description: Client default discount nullable: true has_intent_declaration: type: boolean description: Client has intent declaration nullable: true intent_declaration_protocol_number: type: string description: Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Client creation date updated_at: type: string nullable: true description: Client last update date nullable: true examples: example-1: value: data: code: AE86 name: Avv. Maria Rossi type: person first_name: Maria last_name: Rossi contact_person: '' vat_number: IT12345640962 tax_code: BLTGNI5ABCDA794E address_street: Via Roma, 1 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia email: maria.rossi@example.com certified_email: maria.rossi@pec.example.com phone: '1234567890' fax: '' notes: '' default_payment_terms: 1 default_payment_terms_type: standard bank_name: Indesa bank_iban: IT40P123456781000000123456 bank_swift_code: AK86PCT shipping_address: Corso Magellano 4 e_invoice: true ei_code: '111111' default_vat: id: 54321 value: 45 description: '' is_disabled: false ModifyClientResponse: description: Client modified. content: application/json: schema: title: ModifyClientResponse type: object properties: data: type: object title: Client properties: id: type: integer description: Client id nullable: true code: type: string example: '123' description: Client code nullable: true name: type: string example: Rossi S.r.l. description: Client name nullable: true type: title: ClientType type: string nullable: true default: null enum: - company - person - pa - condo description: Client type first_name: type: string description: Client first name nullable: true last_name: type: string description: Client last name nullable: true contact_person: type: string nullable: true description: Client contact person vat_number: type: string example: IT01234567890 description: Client vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Client tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Client address street nullable: true address_postal_code: type: string example: '24010' description: Client address postal code nullable: true address_city: type: string example: Bergamo description: Client address city nullable: true address_province: type: string example: BG description: Client address province nullable: true address_extra: type: string description: Client address extra info nullable: true country: type: string example: Italia description: Client country nullable: true country_iso: type: string example: Italia description: Client country iso code nullable: true email: type: string example: mario.rossi@example.it description: Client email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Client certified email nullable: true phone: type: string description: Client phone nullable: true fax: type: string description: Client fax nullable: true notes: type: string description: Client extra nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true default_payment_terms: type: integer example: 30 nullable: true description: Client default payment terms default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true bank_name: type: string description: Client bank name nullable: true bank_iban: type: string description: Client bank iban nullable: true bank_swift_code: type: string description: Client bank swift code nullable: true shipping_address: type: string description: Client shipping address nullable: true e_invoice: type: boolean description: Use e-invoices for this entity nullable: true ei_code: type: string description: | Client e-invoice code nullable: true discount_highlight: type: boolean description: Highlight Discount nullable: true default_discount: type: number description: Client default discount nullable: true has_intent_declaration: type: boolean description: Client has intent declaration nullable: true intent_declaration_protocol_number: type: string description: Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Client creation date updated_at: type: string nullable: true description: Client last update date nullable: true examples: example-1: value: data: code: AE86 name: Avv. Maria Rossi type: person first_name: Maria last_name: Rossi contact_person: '' vat_number: IT12345640962 tax_code: BLTGNI5ABCDA794E address_street: Via Roma, 1 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia email: maria.rossi@example.com certified_email: maria.rossi@pec.example.com phone: '1234567890' fax: '' notes: '' default_payment_terms: 1 default_payment_terms_type: standard bank_name: Indesa bank_iban: IT40P123456781000000123456 bank_swift_code: AK86PCT shipping_address: Corso Magellano 4 e_invoice: true ei_code: '111111' default_vat: id: 54321 value: 45 description: '' is_disabled: false GetSupplierResponse: description: Example response content: application/json: schema: title: GetSupplierResponse type: object properties: data: type: object title: Supplier properties: id: type: integer description: Supplier id nullable: true code: type: string example: '123' description: Supplier code nullable: true name: type: string example: Rossi S.r.l. description: Supplier name nullable: true type: title: SupplierType type: string nullable: true default: null enum: - company - person - pa - condo description: Supplier type first_name: type: string description: Supplier first name nullable: true last_name: type: string description: Supplier last name nullable: true contact_person: type: string nullable: true description: Supplier contact person vat_number: type: string example: IT01234567890 description: Supplier vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Supplier tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Supplier street address nullable: true address_postal_code: type: string example: '24010' description: Supplier postal code nullable: true address_city: type: string example: Bergamo description: Supplier city nullable: true address_province: type: string example: BG description: Supplier province nullable: true address_extra: type: string description: Supplier address extra info nullable: true country: type: string example: Italia description: Supplier country nullable: true country_iso: type: string example: Italia description: Supplier country iso code nullable: true email: type: string example: mario.rossi@example.it description: Supplier email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Supplier certified email nullable: true phone: type: string description: Supplier phone nullable: true fax: type: string description: Supplier fax nullable: true notes: type: string description: Supplier extra notes nullable: true bank_iban: type: string description: Supplier bank IBAN nullable: true created_at: type: string nullable: true description: Supplier creation date updated_at: type: string nullable: true description: Supplier last update date nullable: true examples: example-1: value: data: id: 12345 code: AE86 name: Mario Rossi S.R.L. type: company first_name: Mario last_name: Rossi contact_person: '' vat_number: '111222333' tax_code: '111122233' address_street: Corso Magellano, 46 address_postal_code: '20146' address_city: Milano address_province: MI address_extra: '' country: Italia email: mario.rossi@example.com certified_email: mario.rossi@pec.example.com phone: '1234567890' fax: '123456789' notes: '' created_at: '2021-15-08' updated_at: '2021-15-08' ModifySupplierResponse: description: Example response content: application/json: schema: title: ModifySupplierResponse type: object properties: data: type: object title: Supplier properties: id: type: integer description: Supplier id nullable: true code: type: string example: '123' description: Supplier code nullable: true name: type: string example: Rossi S.r.l. description: Supplier name nullable: true type: title: SupplierType type: string nullable: true default: null enum: - company - person - pa - condo description: Supplier type first_name: type: string description: Supplier first name nullable: true last_name: type: string description: Supplier last name nullable: true contact_person: type: string nullable: true description: Supplier contact person vat_number: type: string example: IT01234567890 description: Supplier vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Supplier tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Supplier street address nullable: true address_postal_code: type: string example: '24010' description: Supplier postal code nullable: true address_city: type: string example: Bergamo description: Supplier city nullable: true address_province: type: string example: BG description: Supplier province nullable: true address_extra: type: string description: Supplier address extra info nullable: true country: type: string example: Italia description: Supplier country nullable: true country_iso: type: string example: Italia description: Supplier country iso code nullable: true email: type: string example: mario.rossi@example.it description: Supplier email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Supplier certified email nullable: true phone: type: string description: Supplier phone nullable: true fax: type: string description: Supplier fax nullable: true notes: type: string description: Supplier extra notes nullable: true bank_iban: type: string description: Supplier bank IBAN nullable: true created_at: type: string nullable: true description: Supplier creation date updated_at: type: string nullable: true description: Supplier last update date nullable: true examples: example-1: value: data: id: 12345 code: AE86 name: Mario Rossi S.R.L. type: company first_name: Mario last_name: Rossi contact_person: '' vat_number: '111222333' tax_code: '111122233' address_street: Corso Magellano, 46 address_postal_code: '20146' address_city: Milano address_province: MI address_extra: '' country: Italia email: mario.rossi@example.com certified_email: mario.rossi@pec.example.com phone: '1234567890' fax: '123456789' notes: '' created_at: '2021-15-08' updated_at: '2021-15-08' ListProductsResponse: description: Products List. content: application/json: schema: title: ListProductsResponse allOf: - title: Pagination type: object description: '' properties: current_page: type: integer description: Current page number. nullable: true first_page_url: type: string format: uri description: First page url. nullable: true from: type: integer nullable: true description: First result of the page. last_page: type: integer description: Last page number. nullable: true last_page_url: type: string format: uri description: Last page url. nullable: true next_page_url: type: string format: uri nullable: true description: Next page url path: type: string format: uri description: Request path. nullable: true per_page: type: integer description: Number of result per page. nullable: true prev_page_url: type: string format: uri nullable: true description: Previous page url. to: type: integer nullable: true description: Last result of the page. total: type: integer description: Total number of results nullable: true - title: ListProductsResponsePage type: object properties: data: type: array items: type: object title: Product properties: id: type: integer description: Product id nullable: true name: type: string description: Product name nullable: true code: type: string nullable: true description: Product code net_price: type: number nullable: true description: Product net price gross_price: type: number nullable: true description: Product gross price use_gross_price: type: boolean description: Product uses gross prices nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true net_cost: type: number nullable: true description: Product net cost measure: type: string nullable: true description: Product measure description: type: string description: Product description nullable: true category: type: string description: Product category nullable: true notes: type: string nullable: true description: Product extra notes in_stock: type: boolean description: Product has stock nullable: true stock_initial: type: number description: Product initial stock nullable: true stock_current: type: number description: |- [Read Only] Product current stock nullable: true readOnly: true average_cost: type: number description: Product average cost nullable: true average_price: type: number description: Product average price nullable: true created_at: type: string nullable: true description: Product creation date updated_at: type: string nullable: true description: Product last update date nullable: true examples: example-1: value: current_page: 1 data: - id: 12345 name: Tavolo di marmo code: TAVOLO003 net_price: 240 gross_price: 280 use_gross_price: false net_cost: 0 measure: '' description: Tavolo in marmo pregiato category: arredamento in_stock: true default_vat: id: 3 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 is_disabled: false - id: 12346 name: Tavolo di legno code: TAVOLO001 net_price: 120 gross_price: 160 use_gross_price: false net_cost: 0 measure: '' description: Tavolo in legno pregiato category: arredamento in_stock: true default_vat: id: 3 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 is_disabled: false first_page_url: page=1 from: 1 last_page: 1 last_page_url: page=1 next_page_url: page=2 path: products per_page: 50 prev_page_url: null to: 55 total: 55 CreateProductResponse: description: Example response content: application/json: schema: title: CreateProductResponse type: object properties: data: type: object title: Product properties: id: type: integer description: Product id nullable: true name: type: string description: Product name nullable: true code: type: string nullable: true description: Product code net_price: type: number nullable: true description: Product net price gross_price: type: number nullable: true description: Product gross price use_gross_price: type: boolean description: Product uses gross prices nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true net_cost: type: number nullable: true description: Product net cost measure: type: string nullable: true description: Product measure description: type: string description: Product description nullable: true category: type: string description: Product category nullable: true notes: type: string nullable: true description: Product extra notes in_stock: type: boolean description: Product has stock nullable: true stock_initial: type: number description: Product initial stock nullable: true stock_current: type: number description: |- [Read Only] Product current stock nullable: true readOnly: true average_cost: type: number description: Product average cost nullable: true average_price: type: number description: Product average price nullable: true created_at: type: string nullable: true description: Product creation date updated_at: type: string nullable: true description: Product last update date nullable: true examples: example-1: value: data: id: 12345 name: Tavolo di marmo code: TAVOLO003 net_price: 240 gross_price: 280 use_gross_price: false net_cost: 0 measure: '' description: Tavolo in marmo pregiato category: arredamento in_stock: true default_vat: id: 3 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 is_disabled: false GetProductResponse: description: Example response content: application/json: schema: title: GetProductResponse type: object properties: data: type: object title: Product properties: id: type: integer description: Product id nullable: true name: type: string description: Product name nullable: true code: type: string nullable: true description: Product code net_price: type: number nullable: true description: Product net price gross_price: type: number nullable: true description: Product gross price use_gross_price: type: boolean description: Product uses gross prices nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true net_cost: type: number nullable: true description: Product net cost measure: type: string nullable: true description: Product measure description: type: string description: Product description nullable: true category: type: string description: Product category nullable: true notes: type: string nullable: true description: Product extra notes in_stock: type: boolean description: Product has stock nullable: true stock_initial: type: number description: Product initial stock nullable: true stock_current: type: number description: |- [Read Only] Product current stock nullable: true readOnly: true average_cost: type: number description: Product average cost nullable: true average_price: type: number description: Product average price nullable: true created_at: type: string nullable: true description: Product creation date updated_at: type: string nullable: true description: Product last update date nullable: true examples: example-1: value: data: id: 12345 name: Tavolo di marmo code: TAVOLO003 net_price: 240 gross_price: 280 use_gross_price: false net_cost: 0 measure: '' description: Tavolo in marmo pregiato category: arredamento in_stock: true created_at: '2021-08-09 08:57:14' updated_at: '2021-08-09 08:57:14' default_vat: id: 3 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 is_disabled: false stock_initial: 123 stock_current: 123 ModifyProductResponse: description: Example response content: application/json: schema: title: ModifyProductResponse type: object properties: data: type: object title: Product properties: id: type: integer description: Product id nullable: true name: type: string description: Product name nullable: true code: type: string nullable: true description: Product code net_price: type: number nullable: true description: Product net price gross_price: type: number nullable: true description: Product gross price use_gross_price: type: boolean description: Product uses gross prices nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true net_cost: type: number nullable: true description: Product net cost measure: type: string nullable: true description: Product measure description: type: string description: Product description nullable: true category: type: string description: Product category nullable: true notes: type: string nullable: true description: Product extra notes in_stock: type: boolean description: Product has stock nullable: true stock_initial: type: number description: Product initial stock nullable: true stock_current: type: number description: |- [Read Only] Product current stock nullable: true readOnly: true average_cost: type: number description: Product average cost nullable: true average_price: type: number description: Product average price nullable: true created_at: type: string nullable: true description: Product creation date updated_at: type: string nullable: true description: Product last update date nullable: true examples: example-1: value: data: id: 12345 name: Tavolo di marmo code: TAVOLO003 net_price: 240 gross_price: 280 use_gross_price: false net_cost: 0 measure: '' description: Tavolo in marmo pregiato category: arredamento in_stock: true created_at: '2021-08-09 08:57:14' updated_at: '2021-08-15 08:57:14' default_vat: id: 3 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 is_disabled: false stock_initial: 123 stock_current: 123 ListIssuedDocumentsResponse: description: Results list. content: application/json: schema: title: ListIssuedDocumentsResponse allOf: - title: Pagination type: object description: '' properties: current_page: type: integer description: Current page number. nullable: true first_page_url: type: string format: uri description: First page url. nullable: true from: type: integer nullable: true description: First result of the page. last_page: type: integer description: Last page number. nullable: true last_page_url: type: string format: uri description: Last page url. nullable: true next_page_url: type: string format: uri nullable: true description: Next page url path: type: string format: uri description: Request path. nullable: true per_page: type: integer description: Number of result per page. nullable: true prev_page_url: type: string format: uri nullable: true description: Previous page url. to: type: integer nullable: true description: Last result of the page. total: type: integer description: Total number of results nullable: true - title: ListIssuedDocumentResponsePage type: object properties: data: type: array items: title: IssuedDocument type: object properties: id: type: integer description: Issued document id nullable: true entity: title: Entity type: object properties: id: type: integer nullable: true description: Entity id code: type: string example: '123' description: Entity code nullable: true name: type: string example: Rossi S.r.l. description: Entity name nullable: true type: title: EntityType type: string nullable: true default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name nullable: true last_name: type: string description: Entity last name nullable: true contact_person: type: string nullable: true description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Entitity address street nullable: true address_postal_code: type: string example: '24010' nullable: true description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city nullable: true address_province: type: string example: BG description: Entity address province nullable: true address_extra: type: string description: Entity address extra info nullable: true country: type: string example: Italia description: Entity country nullable: true country_iso: type: string example: Italia description: Entity country iso code nullable: true email: type: string example: mario.rossi@example.it description: Entity email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email nullable: true phone: type: string nullable: true description: Entity phone fax: type: string nullable: true description: Entity fax notes: type: string description: Entity extra nullable: true default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name nullable: true bank_iban: type: string description: |- [Only for client] Client bank iban nullable: true bank_swift_code: type: string description: |- [Only for client] Client bank swift code nullable: true shipping_address: type: string description: |- [Only for client] Client Shipping address nullable: true e_invoice: type: boolean description: |- [Only for client] Use e-invoices. nullable: true ei_code: type: string description: |- [Only for client] E-invoices code. nullable: true has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. nullable: true intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Entity creation date updated_at: type: string nullable: true description: Entity last update date type: type: string default: invoice enum: - invoice - quote - proforma - receipt - delivery_note - credit_note - order - work_report - supplier_order - self_own_invoice - self_supplier_invoice description: Issued document type number: type: integer description: |- Issued document number [If not specified, next number is used] example: 1 nullable: true numeration: type: string description: |- Issued document numeration [Not available if type=delivery_note] example: /A nullable: true date: type: string description: |- Issued document date [defaults to today's date] format: date nullable: true year: type: integer description: Issued document year nullable: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true language: type: object title: Language properties: code: type: string description: Language code nullable: true name: type: string description: Language extended name nullable: true subject: type: string description: Issued document subject nullable: true visible_subject: type: string description: Issued document visible subject nullable: true rc_center: type: string description: >- Issued document revenue center [or cost center if type=supplier_order]. nullable: true notes: type: string description: Issued document extra notes nullable: true rivalsa: type: number description: Issued document "Rivalsa INPS" percentual value nullable: true cassa: type: number description: >- Issued document "Cassa previdenziale" percentual value nullable: true amount_cassa: type: number description: |- [Read Only] Issued document cassa amount. nullable: true readOnly: true cassa_taxable: type: number description: Issued document cassa taxable percentage nullable: true amount_cassa_taxable: type: number nullable: true description: |- [Can be set only if cassa_taxable is NULL] Issued document cassa taxable amount cassa2: type: number description: >- Issued document "Cassa previdenziale 2" percentual value nullable: true amount_cassa2: type: number nullable: true description: |- [Read Only] Issued document cassa2 amount readOnly: true cassa2_taxable: type: number description: Issued document cassa2 taxable percentage nullable: true amount_cassa2_taxable: type: number nullable: true description: |- [Can be set only if cassa2_taxable is NULL] Issued document cassa2 taxable amount global_cassa_taxable: type: number description: Issued document global cassa taxable percentage nullable: true amount_global_cassa_taxable: type: number nullable: true description: |- [Can be set only if global_cassa_taxable is NULL] Issued document global cassa taxable amount withholding_tax: type: number description: >- Issued document withholding tax (ritenuta d'acconto) percentual value nullable: true withholding_tax_taxable: type: number description: >- Issued document withholding tax taxable (imponibile) percentual value nullable: true other_withholding_tax: type: number description: >- Issued document other withholding tax (altra ritenuta) percentual value nullable: true stamp_duty: type: number description: |- Issued document stamp duty value [0 if not present] nullable: true payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true use_split_payment: type: boolean description: Issued document uses split payment nullable: true use_gross_prices: type: boolean description: Issued document uses gross prices nullable: true e_invoice: type: boolean description: Issued document is an e-invoice. nullable: true ei_data: type: object nullable: true description: |- Issued document e-invoice data [Only if e_invoice=true] properties: vat_kind: title: VatKind type: string nullable: true description: Vat kind [esigibilità IVA] default: null enum: - null - I - D - S original_document_type: title: OriginalDocumentType type: string nullable: true description: Issued document original document type default: null enum: - ordine - contratto - convenzione od_number: type: string nullable: true description: E-invoice original document number od_date: type: string description: E-invoice original document date format: date nullable: true cig: type: string nullable: true description: E-invoice CIG cup: type: string nullable: true description: E-invoice CUP payment_method: type: string nullable: true description: >- E-invoice payment method [required for e-invoices] (see [here](https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.2/Rappresentazione_Tabellare_FattOrdinaria_V1.2.2.pdf) for the accepted values of ModalitaPagamento) bank_name: type: string nullable: true description: E-invoice bank name bank_iban: type: string nullable: true description: E-invoice bank IBAN bank_beneficiary: type: string nullable: true description: E-invoice bank beneficiary invoice_number: type: string description: E-invoice invoice number nullable: true invoice_date: type: string format: date description: E-invoice invoice date nullable: true ei_cassa_type: type: string nullable: true description: E-invoice cassa type ei_cassa2_type: type: string nullable: true description: E-invoice cassa2 type ei_withholding_tax_causal: type: string nullable: true description: E-invoice withholding tax causal ei_other_withholding_tax_type: type: string nullable: true description: E-invoice other withholding tax type ei_other_withholding_tax_causal: type: string nullable: true description: E-invoice other withholding tax causal items_list: type: array nullable: true items: title: IssuedDocumentItemsListItem type: object properties: id: type: integer description: Issued document item id nullable: true product_id: type: integer nullable: true description: Issued document item product id example: 1234 code: type: string description: Issued document item product code example: '239874892374982' nullable: true name: type: string description: Issued document item product name example: Water bottle nullable: true category: type: string description: Issued document item product category nullable: true description: type: string description: Issued document product description nullable: true qty: type: number description: Issued document item quantity nullable: true measure: type: string description: Issued document item measure nullable: true net_price: type: number description: Issued document item net price example: 1.23 nullable: true gross_price: type: number nullable: true example: 1.45 description: Issued document item gross price vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true not_taxable: type: boolean nullable: true description: Issued document item is not taxable apply_withholding_taxes: type: boolean description: >- Issued document item apply withholding taxes, rivalsa and cassa nullable: true discount: type: number description: Issued document item discount percentual value nullable: true discount_highlight: type: boolean nullable: true description: Issued document item highlight discount in_dn: type: boolean nullable: true description: Issued document item add in delivery note stock: type: boolean nullable: true description: Issued document item move stock ei_raw: type: object description: >- Issued document advanced raw attributes for e-invoices nullable: true payments_list: type: array nullable: true items: title: IssuedDocumentPaymentsListItem type: object properties: id: type: integer description: Issued document payment item id nullable: true due_date: type: string description: Issued document payment due date format: date example: '2018-04-03' nullable: true amount: type: number description: Issued document payment amount example: 1.45 nullable: true status: title: IssuedDocumentStatus type: string description: Issued document status default: not_paid enum: - not_paid - paid - reversed payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true paid_date: type: string description: |- Issued document payment date [Only if status is paid] format: date example: '2018-04-03' nullable: true ei_raw: type: object nullable: true description: >- Issued document payment advanced raw attributes for e-invoices payment_terms: type: object properties: days: type: integer nullable: true description: >- Issued document payment number of days by which the payment must be made type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true delivery_note_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true acc_inv_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true h_margins: type: integer description: Issued document PDF horizontal margins nullable: true v_margins: type: integer description: Issued document PDF vertical margins nullable: true show_payments: type: boolean description: >- Show the expiration dates of the payments on the document nullable: true show_payment_method: type: boolean description: Show the payment method details on the document nullable: true show_totals: title: ShowTotalsMode type: string description: Show totals mode default: all enum: - none - nets - all show_notification_button: type: boolean description: Show notification button in the PDF nullable: true show_tspay_button: type: boolean description: Show ts pay button in the PDF nullable: true delivery_note: type: boolean nullable: true description: Issued document has delivery note accompanying_invoice: type: boolean description: Issued document has an accompanying invoice nullable: true dn_number: type: integer description: Issued document attached delivery note number nullable: true dn_date: type: string description: Issued document attached delivery note date format: date nullable: true dn_ai_packages_number: type: string nullable: true description: >- Issued document attached delivery note number of packages dn_ai_weight: type: string nullable: true description: >- Issued document attached delivery note package weight dn_ai_causal: type: string nullable: true description: Issued document attached delivery note causal dn_ai_destination: type: string nullable: true description: Issued document attached delivery note destination dn_ai_transporter: type: string nullable: true description: Issued document attached delivery note transporter dn_ai_notes: type: string nullable: true description: Issued document attached delivery note notes is_marked: type: boolean description: Issued document is marked nullable: true amount_net: type: number description: |- [Read only] Issued document total net amount nullable: true readOnly: true amount_vat: type: number description: |- [Read Only] Issued document total vat amount nullable: true readOnly: true amount_gross: type: number description: |- [Read Only] Issued document total gross amount nullable: true readOnly: true amount_due_discount: type: number description: Issued document amount due discount nullable: true amount_rivalsa: type: number description: |- [Read Only] Issued document rivalsa amount nullable: true readOnly: true amount_rivalsa_taxable: type: number nullable: true description: Issued document taxable rivalsa amount amount_withholding_tax: type: number description: >- [Read Only] Issued document withholding tax amount (ritenuta d'acconto). nullable: true readOnly: true amount_withholding_tax_taxable: type: number nullable: true description: Issued document taxable withholding tax amount amount_other_withholding_tax: type: number description: >- [Read Only] Issued document other withholding tax amount (altra ritenuta) nullable: true readOnly: true amount_other_withholding_tax_taxable: type: number nullable: true description: Issued document taxable other withholding tax amount amount_enasarco_taxable: type: number nullable: true description: Issued document taxable enasarco amount extra_data: type: object nullable: true description: >- Issued document extra data [TS fields follow the technical specifications provided by "Sistema Tessera Sanitaria"] properties: multifatture_sent: type: integer nullable: true ts_communication: type: boolean nullable: true description: >- Send issued document to "Sistema Tessera Sanitaria" ts_flag_tipo_spesa: type: number nullable: true description: >- Issued document ts "tipo spesa" [TK, FC, FV, SV,SP, AD, AS, ECG, SR] ts_pagamento_tracciato: type: boolean nullable: true description: Issued document ts traced payment ts_tipo_spesa: type: string description: >- Can be [ 'TK', 'FC', 'FV', 'SV', 'SP', 'AD', 'AS', 'SR', 'CT', 'PI', 'IC', 'AA' ]. Refer to the technical specifications to learn more. nullable: true ts_opposizione: type: boolean nullable: true description: Issued document ts "opposizione" ts_status: type: integer nullable: true description: Issued document ts status ts_file_id: type: string nullable: true description: Issued document ts file id ts_sent_date: type: string nullable: true format: date description: Issued document ts sent date ts_full_amount: type: boolean nullable: true description: Issued document ts total amount imported_by: type: string nullable: true description: Issued document imported by software seen_date: type: string nullable: true description: Issued document seen date format: date next_due_date: type: string nullable: true description: Issued document date of the next not paid payment format: date url: type: string description: |- [Temporary] [Read Only] Issued document url of the document PDF file nullable: true dn_url: type: string description: >- [Temporary] [Read Only] Issued document url of the attached delivery note PDF file nullable: true ai_url: type: string description: >- [Temporary] [Read Only] Issued document url of the accompanying invoice PDF file nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached file nullable: true readOnly: true attachment_token: type: string nullable: true description: >- [Write Only] Issued document attachment token returned by POST /issued_documents/attachment writeOnly: true ei_raw: type: object nullable: true description: >- Issued document advanced raw attributes for e-invoices ei_status: type: string description: | [Read only] Status of the e-invoice. * **attempt** - We are trying to send the invoice, please wait up to 2 hours * **missing** - The invoice is missing * **not_sent** - The invoice has yet to be sent * **sent** - The invoice was sent * **pending** - The checks for the digital signature and sending are in progress * **processing** - The SDI is delivering the invoice to the customer * **error** - An error occurred while handling the invoice, please try to resend it or contact support * **discarded** - The invoice has been rejected by the SDI, so it must be corrected and re-sent * **not_delivered** - The SDI was unable to deliver the invoice * **accepted** - The customer accepted the invoice * **rejected** - The customer rejected the invoice, so it must be corrected * **no_response** - A response has not yet been received whithin the deadline, contact the customer to ascertain the status of the invoice * **manual_accepted** - The customer accepted the invoice * **manual_rejected** - The customer rejected the invoice enum: - attempt - missing - not_sent - sent - pending - processing - error - discarded - not_delivered - accepted - rejected - no_response - manual_accepted - manual_rejected nullable: true locked: type: boolean nullable: true description: Issued Document can't be edited created_at: type: string nullable: true description: Issued document creation date updated_at: type: string nullable: true description: Issued document last update date nullable: true examples: example-1: value: current_page: 1 data: - id: 12345 type: receipt numeration: rec123 subject: '' visible_subject: '' amount_net: 68.18 amount_vat: 6.82 amount_gross: 75 amount_due_discount: 0 entity: id: 54321 name: Mary Red S.r.L. vat_number: IT05432181211 tax_code: IT05432181211 address_street: Via Italia, 66 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia certified_email: mary@pec.red.com ei_code: ABCXCR1 date: '2021-08-20' number: 1 next_due_date: '2021-12-31' url: ypbqqe4u8w8bdabcd5fd5b1a4gtqhlof.pdf items_list: null payments_list: null - id: 12346 type: receipt numeration: rec124 subject: '' visible_subject: '' amount_net: 168.18 amount_vat: 16.82 amount_gross: 175 amount_due_discount: 0 entity: id: 54321 name: Mary Red S.r.L. vat_number: IT05432181211 tax_code: IT05432181211 address_street: Via Italia, 66 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia certified_email: mary@pec.red.com ei_code: ABCXCR1 date: '2021-08-28' number: 1 next_due_date: '2021-12-31' url: qwertye4u8w8bdaqrt5fd5b1a4gtqhlof.pdf items_list: null payments_list: null first_page_url: page=1 from: 1 last_page: 1 last_page_url: page=1 next_page_url: null path: issued_documents per_page: 50 prev_page_url: null to: 2 total: 2 CreateIssuedDocumentResponse: description: Document created. content: application/json: schema: title: CreateIssuedDocumentResponse type: object properties: data: title: IssuedDocument type: object properties: id: type: integer description: Issued document id nullable: true entity: title: Entity type: object properties: id: type: integer nullable: true description: Entity id code: type: string example: '123' description: Entity code nullable: true name: type: string example: Rossi S.r.l. description: Entity name nullable: true type: title: EntityType type: string nullable: true default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name nullable: true last_name: type: string description: Entity last name nullable: true contact_person: type: string nullable: true description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Entitity address street nullable: true address_postal_code: type: string example: '24010' nullable: true description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city nullable: true address_province: type: string example: BG description: Entity address province nullable: true address_extra: type: string description: Entity address extra info nullable: true country: type: string example: Italia description: Entity country nullable: true country_iso: type: string example: Italia description: Entity country iso code nullable: true email: type: string example: mario.rossi@example.it description: Entity email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email nullable: true phone: type: string nullable: true description: Entity phone fax: type: string nullable: true description: Entity fax notes: type: string description: Entity extra nullable: true default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name nullable: true bank_iban: type: string description: |- [Only for client] Client bank iban nullable: true bank_swift_code: type: string description: |- [Only for client] Client bank swift code nullable: true shipping_address: type: string description: |- [Only for client] Client Shipping address nullable: true e_invoice: type: boolean description: |- [Only for client] Use e-invoices. nullable: true ei_code: type: string description: |- [Only for client] E-invoices code. nullable: true has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. nullable: true intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Entity creation date updated_at: type: string nullable: true description: Entity last update date type: type: string default: invoice enum: - invoice - quote - proforma - receipt - delivery_note - credit_note - order - work_report - supplier_order - self_own_invoice - self_supplier_invoice description: Issued document type number: type: integer description: |- Issued document number [If not specified, next number is used] example: 1 nullable: true numeration: type: string description: |- Issued document numeration [Not available if type=delivery_note] example: /A nullable: true date: type: string description: |- Issued document date [defaults to today's date] format: date nullable: true year: type: integer description: Issued document year nullable: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true language: type: object title: Language properties: code: type: string description: Language code nullable: true name: type: string description: Language extended name nullable: true subject: type: string description: Issued document subject nullable: true visible_subject: type: string description: Issued document visible subject nullable: true rc_center: type: string description: >- Issued document revenue center [or cost center if type=supplier_order]. nullable: true notes: type: string description: Issued document extra notes nullable: true rivalsa: type: number description: Issued document "Rivalsa INPS" percentual value nullable: true cassa: type: number description: Issued document "Cassa previdenziale" percentual value nullable: true amount_cassa: type: number description: |- [Read Only] Issued document cassa amount. nullable: true readOnly: true cassa_taxable: type: number description: Issued document cassa taxable percentage nullable: true amount_cassa_taxable: type: number nullable: true description: |- [Can be set only if cassa_taxable is NULL] Issued document cassa taxable amount cassa2: type: number description: Issued document "Cassa previdenziale 2" percentual value nullable: true amount_cassa2: type: number nullable: true description: |- [Read Only] Issued document cassa2 amount readOnly: true cassa2_taxable: type: number description: Issued document cassa2 taxable percentage nullable: true amount_cassa2_taxable: type: number nullable: true description: |- [Can be set only if cassa2_taxable is NULL] Issued document cassa2 taxable amount global_cassa_taxable: type: number description: Issued document global cassa taxable percentage nullable: true amount_global_cassa_taxable: type: number nullable: true description: |- [Can be set only if global_cassa_taxable is NULL] Issued document global cassa taxable amount withholding_tax: type: number description: >- Issued document withholding tax (ritenuta d'acconto) percentual value nullable: true withholding_tax_taxable: type: number description: >- Issued document withholding tax taxable (imponibile) percentual value nullable: true other_withholding_tax: type: number description: >- Issued document other withholding tax (altra ritenuta) percentual value nullable: true stamp_duty: type: number description: |- Issued document stamp duty value [0 if not present] nullable: true payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true use_split_payment: type: boolean description: Issued document uses split payment nullable: true use_gross_prices: type: boolean description: Issued document uses gross prices nullable: true e_invoice: type: boolean description: Issued document is an e-invoice. nullable: true ei_data: type: object nullable: true description: |- Issued document e-invoice data [Only if e_invoice=true] properties: vat_kind: title: VatKind type: string nullable: true description: Vat kind [esigibilità IVA] default: null enum: - null - I - D - S original_document_type: title: OriginalDocumentType type: string nullable: true description: Issued document original document type default: null enum: - ordine - contratto - convenzione od_number: type: string nullable: true description: E-invoice original document number od_date: type: string description: E-invoice original document date format: date nullable: true cig: type: string nullable: true description: E-invoice CIG cup: type: string nullable: true description: E-invoice CUP payment_method: type: string nullable: true description: >- E-invoice payment method [required for e-invoices] (see [here](https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.2/Rappresentazione_Tabellare_FattOrdinaria_V1.2.2.pdf) for the accepted values of ModalitaPagamento) bank_name: type: string nullable: true description: E-invoice bank name bank_iban: type: string nullable: true description: E-invoice bank IBAN bank_beneficiary: type: string nullable: true description: E-invoice bank beneficiary invoice_number: type: string description: E-invoice invoice number nullable: true invoice_date: type: string format: date description: E-invoice invoice date nullable: true ei_cassa_type: type: string nullable: true description: E-invoice cassa type ei_cassa2_type: type: string nullable: true description: E-invoice cassa2 type ei_withholding_tax_causal: type: string nullable: true description: E-invoice withholding tax causal ei_other_withholding_tax_type: type: string nullable: true description: E-invoice other withholding tax type ei_other_withholding_tax_causal: type: string nullable: true description: E-invoice other withholding tax causal items_list: type: array nullable: true items: title: IssuedDocumentItemsListItem type: object properties: id: type: integer description: Issued document item id nullable: true product_id: type: integer nullable: true description: Issued document item product id example: 1234 code: type: string description: Issued document item product code example: '239874892374982' nullable: true name: type: string description: Issued document item product name example: Water bottle nullable: true category: type: string description: Issued document item product category nullable: true description: type: string description: Issued document product description nullable: true qty: type: number description: Issued document item quantity nullable: true measure: type: string description: Issued document item measure nullable: true net_price: type: number description: Issued document item net price example: 1.23 nullable: true gross_price: type: number nullable: true example: 1.45 description: Issued document item gross price vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true not_taxable: type: boolean nullable: true description: Issued document item is not taxable apply_withholding_taxes: type: boolean description: >- Issued document item apply withholding taxes, rivalsa and cassa nullable: true discount: type: number description: Issued document item discount percentual value nullable: true discount_highlight: type: boolean nullable: true description: Issued document item highlight discount in_dn: type: boolean nullable: true description: Issued document item add in delivery note stock: type: boolean nullable: true description: Issued document item move stock ei_raw: type: object description: >- Issued document advanced raw attributes for e-invoices nullable: true payments_list: type: array nullable: true items: title: IssuedDocumentPaymentsListItem type: object properties: id: type: integer description: Issued document payment item id nullable: true due_date: type: string description: Issued document payment due date format: date example: '2018-04-03' nullable: true amount: type: number description: Issued document payment amount example: 1.45 nullable: true status: title: IssuedDocumentStatus type: string description: Issued document status default: not_paid enum: - not_paid - paid - reversed payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true paid_date: type: string description: |- Issued document payment date [Only if status is paid] format: date example: '2018-04-03' nullable: true ei_raw: type: object nullable: true description: >- Issued document payment advanced raw attributes for e-invoices payment_terms: type: object properties: days: type: integer nullable: true description: >- Issued document payment number of days by which the payment must be made type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true delivery_note_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true acc_inv_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true h_margins: type: integer description: Issued document PDF horizontal margins nullable: true v_margins: type: integer description: Issued document PDF vertical margins nullable: true show_payments: type: boolean description: Show the expiration dates of the payments on the document nullable: true show_payment_method: type: boolean description: Show the payment method details on the document nullable: true show_totals: title: ShowTotalsMode type: string description: Show totals mode default: all enum: - none - nets - all show_notification_button: type: boolean description: Show notification button in the PDF nullable: true show_tspay_button: type: boolean description: Show ts pay button in the PDF nullable: true delivery_note: type: boolean nullable: true description: Issued document has delivery note accompanying_invoice: type: boolean description: Issued document has an accompanying invoice nullable: true dn_number: type: integer description: Issued document attached delivery note number nullable: true dn_date: type: string description: Issued document attached delivery note date format: date nullable: true dn_ai_packages_number: type: string nullable: true description: Issued document attached delivery note number of packages dn_ai_weight: type: string nullable: true description: Issued document attached delivery note package weight dn_ai_causal: type: string nullable: true description: Issued document attached delivery note causal dn_ai_destination: type: string nullable: true description: Issued document attached delivery note destination dn_ai_transporter: type: string nullable: true description: Issued document attached delivery note transporter dn_ai_notes: type: string nullable: true description: Issued document attached delivery note notes is_marked: type: boolean description: Issued document is marked nullable: true amount_net: type: number description: |- [Read only] Issued document total net amount nullable: true readOnly: true amount_vat: type: number description: |- [Read Only] Issued document total vat amount nullable: true readOnly: true amount_gross: type: number description: |- [Read Only] Issued document total gross amount nullable: true readOnly: true amount_due_discount: type: number description: Issued document amount due discount nullable: true amount_rivalsa: type: number description: |- [Read Only] Issued document rivalsa amount nullable: true readOnly: true amount_rivalsa_taxable: type: number nullable: true description: Issued document taxable rivalsa amount amount_withholding_tax: type: number description: >- [Read Only] Issued document withholding tax amount (ritenuta d'acconto). nullable: true readOnly: true amount_withholding_tax_taxable: type: number nullable: true description: Issued document taxable withholding tax amount amount_other_withholding_tax: type: number description: >- [Read Only] Issued document other withholding tax amount (altra ritenuta) nullable: true readOnly: true amount_other_withholding_tax_taxable: type: number nullable: true description: Issued document taxable other withholding tax amount amount_enasarco_taxable: type: number nullable: true description: Issued document taxable enasarco amount extra_data: type: object nullable: true description: >- Issued document extra data [TS fields follow the technical specifications provided by "Sistema Tessera Sanitaria"] properties: multifatture_sent: type: integer nullable: true ts_communication: type: boolean nullable: true description: Send issued document to "Sistema Tessera Sanitaria" ts_flag_tipo_spesa: type: number nullable: true description: >- Issued document ts "tipo spesa" [TK, FC, FV, SV,SP, AD, AS, ECG, SR] ts_pagamento_tracciato: type: boolean nullable: true description: Issued document ts traced payment ts_tipo_spesa: type: string description: >- Can be [ 'TK', 'FC', 'FV', 'SV', 'SP', 'AD', 'AS', 'SR', 'CT', 'PI', 'IC', 'AA' ]. Refer to the technical specifications to learn more. nullable: true ts_opposizione: type: boolean nullable: true description: Issued document ts "opposizione" ts_status: type: integer nullable: true description: Issued document ts status ts_file_id: type: string nullable: true description: Issued document ts file id ts_sent_date: type: string nullable: true format: date description: Issued document ts sent date ts_full_amount: type: boolean nullable: true description: Issued document ts total amount imported_by: type: string nullable: true description: Issued document imported by software seen_date: type: string nullable: true description: Issued document seen date format: date next_due_date: type: string nullable: true description: Issued document date of the next not paid payment format: date url: type: string description: |- [Temporary] [Read Only] Issued document url of the document PDF file nullable: true dn_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached delivery note PDF file nullable: true ai_url: type: string description: |- [Temporary] [Read Only] Issued document url of the accompanying invoice PDF file nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached file nullable: true readOnly: true attachment_token: type: string nullable: true description: >- [Write Only] Issued document attachment token returned by POST /issued_documents/attachment writeOnly: true ei_raw: type: object nullable: true description: Issued document advanced raw attributes for e-invoices ei_status: type: string description: | [Read only] Status of the e-invoice. * **attempt** - We are trying to send the invoice, please wait up to 2 hours * **missing** - The invoice is missing * **not_sent** - The invoice has yet to be sent * **sent** - The invoice was sent * **pending** - The checks for the digital signature and sending are in progress * **processing** - The SDI is delivering the invoice to the customer * **error** - An error occurred while handling the invoice, please try to resend it or contact support * **discarded** - The invoice has been rejected by the SDI, so it must be corrected and re-sent * **not_delivered** - The SDI was unable to deliver the invoice * **accepted** - The customer accepted the invoice * **rejected** - The customer rejected the invoice, so it must be corrected * **no_response** - A response has not yet been received whithin the deadline, contact the customer to ascertain the status of the invoice * **manual_accepted** - The customer accepted the invoice * **manual_rejected** - The customer rejected the invoice enum: - attempt - missing - not_sent - sent - pending - processing - error - discarded - not_delivered - accepted - rejected - no_response - manual_accepted - manual_rejected nullable: true locked: type: boolean nullable: true description: Issued Document can't be edited created_at: type: string nullable: true description: Issued document creation date updated_at: type: string nullable: true description: Issued document last update date nullable: true examples: example-1: value: data: id: 12345 type: receipt year: 2021 numeration: rec123 subject: '' visible_subject: '' rc_center: '' ei_cassa_type: null ei_withholding_tax_causal: null ei_other_withholding_tax_type: null ei_other_withholding_tax_causal: null stamp_duty: 0 use_gross_prices: false e_invoice: false agyo_company_id: null agyo_id: null agyo_sent_at: null delivery_note: false accompanying_invoice: false amount_net: 68.18 amount_vat: 6.82 amount_gross: 75 amount_due_discount: 0 amount_rivalsa: 0 amount_cassa: 0 amount_withholding_tax: 0 amount_other_withholding_tax: 0 h_margins: 15 v_margins: 16 show_payment_method: false show_payments: true show_totals: all show_notification_button: false is_marked: false created_at: '2021-08-13 09:30:20' updated_at: '2021-08-23 05:34:20' entity: id: 54321 name: Mary Red S.r.L. vat_number: IT05432181211 tax_code: IT05432181211 address_street: Via Italia, 66 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia certified_email: mary@pec.red.com ei_code: ABCXCR1 date: '2021-08-20' number: 1 currency: id: EUR exchange_rate: '1.00000' symbol: € language: code: it name: Italiano notes: '' rivalsa: 0 cassa: 0 withholding_tax: 0 withholding_tax_taxable: 100 other_withholding_tax: 0 payment_method: id: 4 name: Credit card use_split_payment: false merged_in: null original_document: null items_list: - product_id: 5432 code: SG3 name: Soggiorno measure: '' net_price: 68.18182 category: '' id: 277876033 gross_price: 75 apply_withholding_taxes: true discount: 0 discount_highlight: false in_dn: false qty: 1 vat: id: 3 value: 10 description: '' stock: false description: '' not_taxable: false payments_list: - amount: 75 due_date: '2020-08-23' paid_date: null id: 69078013 payment_terms: days: 0 type: standard status: not_paid attachment_url: kdijrnf893hnwkfk45f50f.pdf seen_date: null next_due_date: '2020-08-23' template: id: 2821 name: Light Smoke extra_data: null url: y12h45rn9yf2mse0p43t7ec90vr.pdf locked: false has_ts_pay_pending_payment: false show_tspay_button: false GetIssuedDocumentResponse: description: Document Details. content: application/json: schema: title: GetIssuedDocumentResponse type: object properties: data: title: IssuedDocument type: object properties: id: type: integer description: Issued document id nullable: true entity: title: Entity type: object properties: id: type: integer nullable: true description: Entity id code: type: string example: '123' description: Entity code nullable: true name: type: string example: Rossi S.r.l. description: Entity name nullable: true type: title: EntityType type: string nullable: true default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name nullable: true last_name: type: string description: Entity last name nullable: true contact_person: type: string nullable: true description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Entitity address street nullable: true address_postal_code: type: string example: '24010' nullable: true description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city nullable: true address_province: type: string example: BG description: Entity address province nullable: true address_extra: type: string description: Entity address extra info nullable: true country: type: string example: Italia description: Entity country nullable: true country_iso: type: string example: Italia description: Entity country iso code nullable: true email: type: string example: mario.rossi@example.it description: Entity email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email nullable: true phone: type: string nullable: true description: Entity phone fax: type: string nullable: true description: Entity fax notes: type: string description: Entity extra nullable: true default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name nullable: true bank_iban: type: string description: |- [Only for client] Client bank iban nullable: true bank_swift_code: type: string description: |- [Only for client] Client bank swift code nullable: true shipping_address: type: string description: |- [Only for client] Client Shipping address nullable: true e_invoice: type: boolean description: |- [Only for client] Use e-invoices. nullable: true ei_code: type: string description: |- [Only for client] E-invoices code. nullable: true has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. nullable: true intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Entity creation date updated_at: type: string nullable: true description: Entity last update date type: type: string default: invoice enum: - invoice - quote - proforma - receipt - delivery_note - credit_note - order - work_report - supplier_order - self_own_invoice - self_supplier_invoice description: Issued document type number: type: integer description: |- Issued document number [If not specified, next number is used] example: 1 nullable: true numeration: type: string description: |- Issued document numeration [Not available if type=delivery_note] example: /A nullable: true date: type: string description: |- Issued document date [defaults to today's date] format: date nullable: true year: type: integer description: Issued document year nullable: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true language: type: object title: Language properties: code: type: string description: Language code nullable: true name: type: string description: Language extended name nullable: true subject: type: string description: Issued document subject nullable: true visible_subject: type: string description: Issued document visible subject nullable: true rc_center: type: string description: >- Issued document revenue center [or cost center if type=supplier_order]. nullable: true notes: type: string description: Issued document extra notes nullable: true rivalsa: type: number description: Issued document "Rivalsa INPS" percentual value nullable: true cassa: type: number description: Issued document "Cassa previdenziale" percentual value nullable: true amount_cassa: type: number description: |- [Read Only] Issued document cassa amount. nullable: true readOnly: true cassa_taxable: type: number description: Issued document cassa taxable percentage nullable: true amount_cassa_taxable: type: number nullable: true description: |- [Can be set only if cassa_taxable is NULL] Issued document cassa taxable amount cassa2: type: number description: Issued document "Cassa previdenziale 2" percentual value nullable: true amount_cassa2: type: number nullable: true description: |- [Read Only] Issued document cassa2 amount readOnly: true cassa2_taxable: type: number description: Issued document cassa2 taxable percentage nullable: true amount_cassa2_taxable: type: number nullable: true description: |- [Can be set only if cassa2_taxable is NULL] Issued document cassa2 taxable amount global_cassa_taxable: type: number description: Issued document global cassa taxable percentage nullable: true amount_global_cassa_taxable: type: number nullable: true description: |- [Can be set only if global_cassa_taxable is NULL] Issued document global cassa taxable amount withholding_tax: type: number description: >- Issued document withholding tax (ritenuta d'acconto) percentual value nullable: true withholding_tax_taxable: type: number description: >- Issued document withholding tax taxable (imponibile) percentual value nullable: true other_withholding_tax: type: number description: >- Issued document other withholding tax (altra ritenuta) percentual value nullable: true stamp_duty: type: number description: |- Issued document stamp duty value [0 if not present] nullable: true payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true use_split_payment: type: boolean description: Issued document uses split payment nullable: true use_gross_prices: type: boolean description: Issued document uses gross prices nullable: true e_invoice: type: boolean description: Issued document is an e-invoice. nullable: true ei_data: type: object nullable: true description: |- Issued document e-invoice data [Only if e_invoice=true] properties: vat_kind: title: VatKind type: string nullable: true description: Vat kind [esigibilità IVA] default: null enum: - null - I - D - S original_document_type: title: OriginalDocumentType type: string nullable: true description: Issued document original document type default: null enum: - ordine - contratto - convenzione od_number: type: string nullable: true description: E-invoice original document number od_date: type: string description: E-invoice original document date format: date nullable: true cig: type: string nullable: true description: E-invoice CIG cup: type: string nullable: true description: E-invoice CUP payment_method: type: string nullable: true description: >- E-invoice payment method [required for e-invoices] (see [here](https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.2/Rappresentazione_Tabellare_FattOrdinaria_V1.2.2.pdf) for the accepted values of ModalitaPagamento) bank_name: type: string nullable: true description: E-invoice bank name bank_iban: type: string nullable: true description: E-invoice bank IBAN bank_beneficiary: type: string nullable: true description: E-invoice bank beneficiary invoice_number: type: string description: E-invoice invoice number nullable: true invoice_date: type: string format: date description: E-invoice invoice date nullable: true ei_cassa_type: type: string nullable: true description: E-invoice cassa type ei_cassa2_type: type: string nullable: true description: E-invoice cassa2 type ei_withholding_tax_causal: type: string nullable: true description: E-invoice withholding tax causal ei_other_withholding_tax_type: type: string nullable: true description: E-invoice other withholding tax type ei_other_withholding_tax_causal: type: string nullable: true description: E-invoice other withholding tax causal items_list: type: array nullable: true items: title: IssuedDocumentItemsListItem type: object properties: id: type: integer description: Issued document item id nullable: true product_id: type: integer nullable: true description: Issued document item product id example: 1234 code: type: string description: Issued document item product code example: '239874892374982' nullable: true name: type: string description: Issued document item product name example: Water bottle nullable: true category: type: string description: Issued document item product category nullable: true description: type: string description: Issued document product description nullable: true qty: type: number description: Issued document item quantity nullable: true measure: type: string description: Issued document item measure nullable: true net_price: type: number description: Issued document item net price example: 1.23 nullable: true gross_price: type: number nullable: true example: 1.45 description: Issued document item gross price vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true not_taxable: type: boolean nullable: true description: Issued document item is not taxable apply_withholding_taxes: type: boolean description: >- Issued document item apply withholding taxes, rivalsa and cassa nullable: true discount: type: number description: Issued document item discount percentual value nullable: true discount_highlight: type: boolean nullable: true description: Issued document item highlight discount in_dn: type: boolean nullable: true description: Issued document item add in delivery note stock: type: boolean nullable: true description: Issued document item move stock ei_raw: type: object description: >- Issued document advanced raw attributes for e-invoices nullable: true payments_list: type: array nullable: true items: title: IssuedDocumentPaymentsListItem type: object properties: id: type: integer description: Issued document payment item id nullable: true due_date: type: string description: Issued document payment due date format: date example: '2018-04-03' nullable: true amount: type: number description: Issued document payment amount example: 1.45 nullable: true status: title: IssuedDocumentStatus type: string description: Issued document status default: not_paid enum: - not_paid - paid - reversed payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true paid_date: type: string description: |- Issued document payment date [Only if status is paid] format: date example: '2018-04-03' nullable: true ei_raw: type: object nullable: true description: >- Issued document payment advanced raw attributes for e-invoices payment_terms: type: object properties: days: type: integer nullable: true description: >- Issued document payment number of days by which the payment must be made type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true delivery_note_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true acc_inv_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true h_margins: type: integer description: Issued document PDF horizontal margins nullable: true v_margins: type: integer description: Issued document PDF vertical margins nullable: true show_payments: type: boolean description: Show the expiration dates of the payments on the document nullable: true show_payment_method: type: boolean description: Show the payment method details on the document nullable: true show_totals: title: ShowTotalsMode type: string description: Show totals mode default: all enum: - none - nets - all show_notification_button: type: boolean description: Show notification button in the PDF nullable: true show_tspay_button: type: boolean description: Show ts pay button in the PDF nullable: true delivery_note: type: boolean nullable: true description: Issued document has delivery note accompanying_invoice: type: boolean description: Issued document has an accompanying invoice nullable: true dn_number: type: integer description: Issued document attached delivery note number nullable: true dn_date: type: string description: Issued document attached delivery note date format: date nullable: true dn_ai_packages_number: type: string nullable: true description: Issued document attached delivery note number of packages dn_ai_weight: type: string nullable: true description: Issued document attached delivery note package weight dn_ai_causal: type: string nullable: true description: Issued document attached delivery note causal dn_ai_destination: type: string nullable: true description: Issued document attached delivery note destination dn_ai_transporter: type: string nullable: true description: Issued document attached delivery note transporter dn_ai_notes: type: string nullable: true description: Issued document attached delivery note notes is_marked: type: boolean description: Issued document is marked nullable: true amount_net: type: number description: |- [Read only] Issued document total net amount nullable: true readOnly: true amount_vat: type: number description: |- [Read Only] Issued document total vat amount nullable: true readOnly: true amount_gross: type: number description: |- [Read Only] Issued document total gross amount nullable: true readOnly: true amount_due_discount: type: number description: Issued document amount due discount nullable: true amount_rivalsa: type: number description: |- [Read Only] Issued document rivalsa amount nullable: true readOnly: true amount_rivalsa_taxable: type: number nullable: true description: Issued document taxable rivalsa amount amount_withholding_tax: type: number description: >- [Read Only] Issued document withholding tax amount (ritenuta d'acconto). nullable: true readOnly: true amount_withholding_tax_taxable: type: number nullable: true description: Issued document taxable withholding tax amount amount_other_withholding_tax: type: number description: >- [Read Only] Issued document other withholding tax amount (altra ritenuta) nullable: true readOnly: true amount_other_withholding_tax_taxable: type: number nullable: true description: Issued document taxable other withholding tax amount amount_enasarco_taxable: type: number nullable: true description: Issued document taxable enasarco amount extra_data: type: object nullable: true description: >- Issued document extra data [TS fields follow the technical specifications provided by "Sistema Tessera Sanitaria"] properties: multifatture_sent: type: integer nullable: true ts_communication: type: boolean nullable: true description: Send issued document to "Sistema Tessera Sanitaria" ts_flag_tipo_spesa: type: number nullable: true description: >- Issued document ts "tipo spesa" [TK, FC, FV, SV,SP, AD, AS, ECG, SR] ts_pagamento_tracciato: type: boolean nullable: true description: Issued document ts traced payment ts_tipo_spesa: type: string description: >- Can be [ 'TK', 'FC', 'FV', 'SV', 'SP', 'AD', 'AS', 'SR', 'CT', 'PI', 'IC', 'AA' ]. Refer to the technical specifications to learn more. nullable: true ts_opposizione: type: boolean nullable: true description: Issued document ts "opposizione" ts_status: type: integer nullable: true description: Issued document ts status ts_file_id: type: string nullable: true description: Issued document ts file id ts_sent_date: type: string nullable: true format: date description: Issued document ts sent date ts_full_amount: type: boolean nullable: true description: Issued document ts total amount imported_by: type: string nullable: true description: Issued document imported by software seen_date: type: string nullable: true description: Issued document seen date format: date next_due_date: type: string nullable: true description: Issued document date of the next not paid payment format: date url: type: string description: |- [Temporary] [Read Only] Issued document url of the document PDF file nullable: true dn_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached delivery note PDF file nullable: true ai_url: type: string description: |- [Temporary] [Read Only] Issued document url of the accompanying invoice PDF file nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached file nullable: true readOnly: true attachment_token: type: string nullable: true description: >- [Write Only] Issued document attachment token returned by POST /issued_documents/attachment writeOnly: true ei_raw: type: object nullable: true description: Issued document advanced raw attributes for e-invoices ei_status: type: string description: | [Read only] Status of the e-invoice. * **attempt** - We are trying to send the invoice, please wait up to 2 hours * **missing** - The invoice is missing * **not_sent** - The invoice has yet to be sent * **sent** - The invoice was sent * **pending** - The checks for the digital signature and sending are in progress * **processing** - The SDI is delivering the invoice to the customer * **error** - An error occurred while handling the invoice, please try to resend it or contact support * **discarded** - The invoice has been rejected by the SDI, so it must be corrected and re-sent * **not_delivered** - The SDI was unable to deliver the invoice * **accepted** - The customer accepted the invoice * **rejected** - The customer rejected the invoice, so it must be corrected * **no_response** - A response has not yet been received whithin the deadline, contact the customer to ascertain the status of the invoice * **manual_accepted** - The customer accepted the invoice * **manual_rejected** - The customer rejected the invoice enum: - attempt - missing - not_sent - sent - pending - processing - error - discarded - not_delivered - accepted - rejected - no_response - manual_accepted - manual_rejected nullable: true locked: type: boolean nullable: true description: Issued Document can't be edited created_at: type: string nullable: true description: Issued document creation date updated_at: type: string nullable: true description: Issued document last update date nullable: true examples: example-1: value: data: id: 12345 type: receipt year: 2021 numeration: rec123 subject: '' visible_subject: '' rc_center: '' ei_cassa_type: null ei_withholding_tax_causal: null ei_other_withholding_tax_type: null ei_other_withholding_tax_causal: null stamp_duty: 0 use_gross_prices: false e_invoice: false agyo_company_id: null agyo_id: null agyo_sent_at: null delivery_note: false accompanying_invoice: false amount_net: 68.18 amount_vat: 6.82 amount_gross: 75 amount_due_discount: 0 amount_rivalsa: 0 amount_cassa: 0 amount_withholding_tax: 0 amount_other_withholding_tax: 0 h_margins: 15 v_margins: 16 show_payment_method: false show_payments: true show_totals: all show_notification_button: false is_marked: false created_at: '2021-08-13 09:30:20' updated_at: '2021-08-23 05:34:20' entity: id: 54321 name: Mary Red S.r.L. vat_number: IT05432181211 tax_code: IT05432181211 address_street: Via Italia, 66 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia certified_email: mary@pec.red.com ei_code: ABCXCR1 date: '2021-08-20' number: 1 currency: id: EUR exchange_rate: '1.00000' symbol: € language: code: it name: Italiano notes: '' rivalsa: 0 cassa: 0 withholding_tax: 0 withholding_tax_taxable: 100 other_withholding_tax: 0 payment_method: id: 4 name: Credit card use_split_payment: false merged_in: null original_document: null items_list: - product_id: 5432 code: SG3 name: Soggiorno measure: '' net_price: 68.18182 category: '' id: 277876033 gross_price: 75 apply_withholding_taxes: true discount: 0 discount_highlight: false in_dn: false qty: 1 vat: id: 3 value: 10 description: '' stock: false description: '' not_taxable: false payments_list: - amount: 75 due_date: '2020-08-23' paid_date: null id: 69078013 payment_terms: days: 0 type: standard status: not_paid attachment_url: kdijrnf893hnwkfk45f50f.pdf seen_date: null next_due_date: '2020-08-23' template: id: 2821 name: Light Smoke extra_data: null url: y12h45rn9yf2mse0p43t7ec90vr.pdf locked: false has_ts_pay_pending_payment: false show_tspay_button: false ModifyIssuedDocumentResponse: description: Document edited content: application/json: schema: title: ModifyIssuedDocumentResponse type: object properties: data: title: IssuedDocument type: object properties: id: type: integer description: Issued document id nullable: true entity: title: Entity type: object properties: id: type: integer nullable: true description: Entity id code: type: string example: '123' description: Entity code nullable: true name: type: string example: Rossi S.r.l. description: Entity name nullable: true type: title: EntityType type: string nullable: true default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name nullable: true last_name: type: string description: Entity last name nullable: true contact_person: type: string nullable: true description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Entitity address street nullable: true address_postal_code: type: string example: '24010' nullable: true description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city nullable: true address_province: type: string example: BG description: Entity address province nullable: true address_extra: type: string description: Entity address extra info nullable: true country: type: string example: Italia description: Entity country nullable: true country_iso: type: string example: Italia description: Entity country iso code nullable: true email: type: string example: mario.rossi@example.it description: Entity email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email nullable: true phone: type: string nullable: true description: Entity phone fax: type: string nullable: true description: Entity fax notes: type: string description: Entity extra nullable: true default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name nullable: true bank_iban: type: string description: |- [Only for client] Client bank iban nullable: true bank_swift_code: type: string description: |- [Only for client] Client bank swift code nullable: true shipping_address: type: string description: |- [Only for client] Client Shipping address nullable: true e_invoice: type: boolean description: |- [Only for client] Use e-invoices. nullable: true ei_code: type: string description: |- [Only for client] E-invoices code. nullable: true has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. nullable: true intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Entity creation date updated_at: type: string nullable: true description: Entity last update date type: type: string default: invoice enum: - invoice - quote - proforma - receipt - delivery_note - credit_note - order - work_report - supplier_order - self_own_invoice - self_supplier_invoice description: Issued document type number: type: integer description: |- Issued document number [If not specified, next number is used] example: 1 nullable: true numeration: type: string description: |- Issued document numeration [Not available if type=delivery_note] example: /A nullable: true date: type: string description: |- Issued document date [defaults to today's date] format: date nullable: true year: type: integer description: Issued document year nullable: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true language: type: object title: Language properties: code: type: string description: Language code nullable: true name: type: string description: Language extended name nullable: true subject: type: string description: Issued document subject nullable: true visible_subject: type: string description: Issued document visible subject nullable: true rc_center: type: string description: >- Issued document revenue center [or cost center if type=supplier_order]. nullable: true notes: type: string description: Issued document extra notes nullable: true rivalsa: type: number description: Issued document "Rivalsa INPS" percentual value nullable: true cassa: type: number description: Issued document "Cassa previdenziale" percentual value nullable: true amount_cassa: type: number description: |- [Read Only] Issued document cassa amount. nullable: true readOnly: true cassa_taxable: type: number description: Issued document cassa taxable percentage nullable: true amount_cassa_taxable: type: number nullable: true description: |- [Can be set only if cassa_taxable is NULL] Issued document cassa taxable amount cassa2: type: number description: Issued document "Cassa previdenziale 2" percentual value nullable: true amount_cassa2: type: number nullable: true description: |- [Read Only] Issued document cassa2 amount readOnly: true cassa2_taxable: type: number description: Issued document cassa2 taxable percentage nullable: true amount_cassa2_taxable: type: number nullable: true description: |- [Can be set only if cassa2_taxable is NULL] Issued document cassa2 taxable amount global_cassa_taxable: type: number description: Issued document global cassa taxable percentage nullable: true amount_global_cassa_taxable: type: number nullable: true description: |- [Can be set only if global_cassa_taxable is NULL] Issued document global cassa taxable amount withholding_tax: type: number description: >- Issued document withholding tax (ritenuta d'acconto) percentual value nullable: true withholding_tax_taxable: type: number description: >- Issued document withholding tax taxable (imponibile) percentual value nullable: true other_withholding_tax: type: number description: >- Issued document other withholding tax (altra ritenuta) percentual value nullable: true stamp_duty: type: number description: |- Issued document stamp duty value [0 if not present] nullable: true payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true use_split_payment: type: boolean description: Issued document uses split payment nullable: true use_gross_prices: type: boolean description: Issued document uses gross prices nullable: true e_invoice: type: boolean description: Issued document is an e-invoice. nullable: true ei_data: type: object nullable: true description: |- Issued document e-invoice data [Only if e_invoice=true] properties: vat_kind: title: VatKind type: string nullable: true description: Vat kind [esigibilità IVA] default: null enum: - null - I - D - S original_document_type: title: OriginalDocumentType type: string nullable: true description: Issued document original document type default: null enum: - ordine - contratto - convenzione od_number: type: string nullable: true description: E-invoice original document number od_date: type: string description: E-invoice original document date format: date nullable: true cig: type: string nullable: true description: E-invoice CIG cup: type: string nullable: true description: E-invoice CUP payment_method: type: string nullable: true description: >- E-invoice payment method [required for e-invoices] (see [here](https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.2/Rappresentazione_Tabellare_FattOrdinaria_V1.2.2.pdf) for the accepted values of ModalitaPagamento) bank_name: type: string nullable: true description: E-invoice bank name bank_iban: type: string nullable: true description: E-invoice bank IBAN bank_beneficiary: type: string nullable: true description: E-invoice bank beneficiary invoice_number: type: string description: E-invoice invoice number nullable: true invoice_date: type: string format: date description: E-invoice invoice date nullable: true ei_cassa_type: type: string nullable: true description: E-invoice cassa type ei_cassa2_type: type: string nullable: true description: E-invoice cassa2 type ei_withholding_tax_causal: type: string nullable: true description: E-invoice withholding tax causal ei_other_withholding_tax_type: type: string nullable: true description: E-invoice other withholding tax type ei_other_withholding_tax_causal: type: string nullable: true description: E-invoice other withholding tax causal items_list: type: array nullable: true items: title: IssuedDocumentItemsListItem type: object properties: id: type: integer description: Issued document item id nullable: true product_id: type: integer nullable: true description: Issued document item product id example: 1234 code: type: string description: Issued document item product code example: '239874892374982' nullable: true name: type: string description: Issued document item product name example: Water bottle nullable: true category: type: string description: Issued document item product category nullable: true description: type: string description: Issued document product description nullable: true qty: type: number description: Issued document item quantity nullable: true measure: type: string description: Issued document item measure nullable: true net_price: type: number description: Issued document item net price example: 1.23 nullable: true gross_price: type: number nullable: true example: 1.45 description: Issued document item gross price vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true not_taxable: type: boolean nullable: true description: Issued document item is not taxable apply_withholding_taxes: type: boolean description: >- Issued document item apply withholding taxes, rivalsa and cassa nullable: true discount: type: number description: Issued document item discount percentual value nullable: true discount_highlight: type: boolean nullable: true description: Issued document item highlight discount in_dn: type: boolean nullable: true description: Issued document item add in delivery note stock: type: boolean nullable: true description: Issued document item move stock ei_raw: type: object description: >- Issued document advanced raw attributes for e-invoices nullable: true payments_list: type: array nullable: true items: title: IssuedDocumentPaymentsListItem type: object properties: id: type: integer description: Issued document payment item id nullable: true due_date: type: string description: Issued document payment due date format: date example: '2018-04-03' nullable: true amount: type: number description: Issued document payment amount example: 1.45 nullable: true status: title: IssuedDocumentStatus type: string description: Issued document status default: not_paid enum: - not_paid - paid - reversed payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true paid_date: type: string description: |- Issued document payment date [Only if status is paid] format: date example: '2018-04-03' nullable: true ei_raw: type: object nullable: true description: >- Issued document payment advanced raw attributes for e-invoices payment_terms: type: object properties: days: type: integer nullable: true description: >- Issued document payment number of days by which the payment must be made type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true delivery_note_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true acc_inv_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true h_margins: type: integer description: Issued document PDF horizontal margins nullable: true v_margins: type: integer description: Issued document PDF vertical margins nullable: true show_payments: type: boolean description: Show the expiration dates of the payments on the document nullable: true show_payment_method: type: boolean description: Show the payment method details on the document nullable: true show_totals: title: ShowTotalsMode type: string description: Show totals mode default: all enum: - none - nets - all show_notification_button: type: boolean description: Show notification button in the PDF nullable: true show_tspay_button: type: boolean description: Show ts pay button in the PDF nullable: true delivery_note: type: boolean nullable: true description: Issued document has delivery note accompanying_invoice: type: boolean description: Issued document has an accompanying invoice nullable: true dn_number: type: integer description: Issued document attached delivery note number nullable: true dn_date: type: string description: Issued document attached delivery note date format: date nullable: true dn_ai_packages_number: type: string nullable: true description: Issued document attached delivery note number of packages dn_ai_weight: type: string nullable: true description: Issued document attached delivery note package weight dn_ai_causal: type: string nullable: true description: Issued document attached delivery note causal dn_ai_destination: type: string nullable: true description: Issued document attached delivery note destination dn_ai_transporter: type: string nullable: true description: Issued document attached delivery note transporter dn_ai_notes: type: string nullable: true description: Issued document attached delivery note notes is_marked: type: boolean description: Issued document is marked nullable: true amount_net: type: number description: |- [Read only] Issued document total net amount nullable: true readOnly: true amount_vat: type: number description: |- [Read Only] Issued document total vat amount nullable: true readOnly: true amount_gross: type: number description: |- [Read Only] Issued document total gross amount nullable: true readOnly: true amount_due_discount: type: number description: Issued document amount due discount nullable: true amount_rivalsa: type: number description: |- [Read Only] Issued document rivalsa amount nullable: true readOnly: true amount_rivalsa_taxable: type: number nullable: true description: Issued document taxable rivalsa amount amount_withholding_tax: type: number description: >- [Read Only] Issued document withholding tax amount (ritenuta d'acconto). nullable: true readOnly: true amount_withholding_tax_taxable: type: number nullable: true description: Issued document taxable withholding tax amount amount_other_withholding_tax: type: number description: >- [Read Only] Issued document other withholding tax amount (altra ritenuta) nullable: true readOnly: true amount_other_withholding_tax_taxable: type: number nullable: true description: Issued document taxable other withholding tax amount amount_enasarco_taxable: type: number nullable: true description: Issued document taxable enasarco amount extra_data: type: object nullable: true description: >- Issued document extra data [TS fields follow the technical specifications provided by "Sistema Tessera Sanitaria"] properties: multifatture_sent: type: integer nullable: true ts_communication: type: boolean nullable: true description: Send issued document to "Sistema Tessera Sanitaria" ts_flag_tipo_spesa: type: number nullable: true description: >- Issued document ts "tipo spesa" [TK, FC, FV, SV,SP, AD, AS, ECG, SR] ts_pagamento_tracciato: type: boolean nullable: true description: Issued document ts traced payment ts_tipo_spesa: type: string description: >- Can be [ 'TK', 'FC', 'FV', 'SV', 'SP', 'AD', 'AS', 'SR', 'CT', 'PI', 'IC', 'AA' ]. Refer to the technical specifications to learn more. nullable: true ts_opposizione: type: boolean nullable: true description: Issued document ts "opposizione" ts_status: type: integer nullable: true description: Issued document ts status ts_file_id: type: string nullable: true description: Issued document ts file id ts_sent_date: type: string nullable: true format: date description: Issued document ts sent date ts_full_amount: type: boolean nullable: true description: Issued document ts total amount imported_by: type: string nullable: true description: Issued document imported by software seen_date: type: string nullable: true description: Issued document seen date format: date next_due_date: type: string nullable: true description: Issued document date of the next not paid payment format: date url: type: string description: |- [Temporary] [Read Only] Issued document url of the document PDF file nullable: true dn_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached delivery note PDF file nullable: true ai_url: type: string description: |- [Temporary] [Read Only] Issued document url of the accompanying invoice PDF file nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached file nullable: true readOnly: true attachment_token: type: string nullable: true description: >- [Write Only] Issued document attachment token returned by POST /issued_documents/attachment writeOnly: true ei_raw: type: object nullable: true description: Issued document advanced raw attributes for e-invoices ei_status: type: string description: | [Read only] Status of the e-invoice. * **attempt** - We are trying to send the invoice, please wait up to 2 hours * **missing** - The invoice is missing * **not_sent** - The invoice has yet to be sent * **sent** - The invoice was sent * **pending** - The checks for the digital signature and sending are in progress * **processing** - The SDI is delivering the invoice to the customer * **error** - An error occurred while handling the invoice, please try to resend it or contact support * **discarded** - The invoice has been rejected by the SDI, so it must be corrected and re-sent * **not_delivered** - The SDI was unable to deliver the invoice * **accepted** - The customer accepted the invoice * **rejected** - The customer rejected the invoice, so it must be corrected * **no_response** - A response has not yet been received whithin the deadline, contact the customer to ascertain the status of the invoice * **manual_accepted** - The customer accepted the invoice * **manual_rejected** - The customer rejected the invoice enum: - attempt - missing - not_sent - sent - pending - processing - error - discarded - not_delivered - accepted - rejected - no_response - manual_accepted - manual_rejected nullable: true locked: type: boolean nullable: true description: Issued Document can't be edited created_at: type: string nullable: true description: Issued document creation date updated_at: type: string nullable: true description: Issued document last update date nullable: true examples: example-1: value: data: id: 12345 type: receipt year: 2021 numeration: rec123 subject: '' visible_subject: '' rc_center: '' ei_cassa_type: null ei_withholding_tax_causal: null ei_other_withholding_tax_type: null ei_other_withholding_tax_causal: null stamp_duty: 0 use_gross_prices: false e_invoice: false agyo_company_id: null agyo_id: null agyo_sent_at: null delivery_note: false accompanying_invoice: false amount_net: 68.18 amount_vat: 6.82 amount_gross: 75 amount_due_discount: 0 amount_rivalsa: 0 amount_cassa: 0 amount_withholding_tax: 0 amount_other_withholding_tax: 0 h_margins: 15 v_margins: 16 show_payment_method: false show_payments: true show_totals: all show_notification_button: false is_marked: false created_at: '2021-08-13 09:30:20' updated_at: '2021-08-23 05:34:20' entity: id: 54321 name: Mary Red S.r.L. vat_number: IT05432181211 tax_code: IT05432181211 address_street: Via Italia, 66 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia certified_email: mary@pec.red.com ei_code: ABCXCR1 date: '2021-08-20' number: 1 currency: id: EUR exchange_rate: '1.00000' symbol: € language: code: it name: Italiano notes: '' rivalsa: 0 cassa: 0 withholding_tax: 0 withholding_tax_taxable: 100 other_withholding_tax: 0 payment_method: id: 4 name: Credit card use_split_payment: false merged_in: null original_document: null items_list: - product_id: 5432 code: SG3 name: Soggiorno measure: '' net_price: 68.18182 category: '' id: 277876033 gross_price: 75 apply_withholding_taxes: true discount: 0 discount_highlight: false in_dn: false qty: 1 vat: id: 3 value: 10 description: '' stock: false description: '' not_taxable: false payments_list: - amount: 75 due_date: '2020-08-23' paid_date: null id: 69078013 payment_terms: days: 0 type: standard status: not_paid payment_account: null attachment_url: kdijrnf893hnwkfk45f50f.pdf seen_date: null next_due_date: '2020-08-23' template: id: 2821 name: Light Smoke extra_data: null url: y12h45rn9yf2mse0p43t7ec90vr.pdf locked: false has_ts_pay_pending_payment: false show_tspay_button: false GetNewIssuedDocumentTotalsResponse: description: Totals. content: application/json: schema: title: GetNewIssuedDocumentTotalsResponse type: object description: '' properties: data: type: object title: IssuedDocumentTotals properties: amount_net: type: number description: Issued document total net amount nullable: true amount_rivalsa: type: number description: Issued document rivalsa amount nullable: true amount_net_with_rivalsa: type: number description: Issued document net amount with rivalsa nullable: true amount_cassa: type: number description: Issued document cassa amount nullable: true taxable_amount: type: number nullable: true description: Issued document taxable amount not_taxable_amount: type: number description: Issued document not taxable amount nullable: true amount_vat: type: number description: Issued document total vat amount nullable: true amount_gross: type: number description: Issued document total gross amount nullable: true taxable_amount_withholding_tax: type: number description: Issued document Taxable withholding tax amount nullable: true amount_withholding_tax: type: number description: Issued document withholding tax amount nullable: true taxable_amount_other_withholding_tax: type: number description: Issued document other withholding tax taxable amount nullable: true amount_other_withholding_tax: type: number description: Issued document other withholding tax amount nullable: true stamp_duty: type: number description: Issued document stamp duty value [0 if not present]. nullable: true amount_due: type: number description: Issued document total amount due nullable: true is_enasarco_maximal_exceeded: type: boolean nullable: true description: Is enasarco maximal excedeed payments_sum: type: number description: Issued document payments sum nullable: true vat_list: title: VatList type: object additionalProperties: type: object title: VatItem properties: amount_net: type: number nullable: true description: Vat item net amount amount_vat: type: number nullable: true description: Vat item vat amount description: Issued document vat list nullable: true examples: example-1: value: data: amount_net: 68.18 taxable_amount: 68.18 vat_list: '10': amount_net: 68.18 amount_vat: 6.82 amount_vat: 6.82 amount_gross: 75 amount_due: 75 amount_due_discount: 0 payments_sum: 75 GetExistingIssuedDocumentTotalsResponse: description: Totals. content: application/json: schema: title: GetExistingIssuedDocumentTotalsResponse type: object description: '' properties: data: type: object title: IssuedDocumentTotals properties: amount_net: type: number description: Issued document total net amount nullable: true amount_rivalsa: type: number description: Issued document rivalsa amount nullable: true amount_net_with_rivalsa: type: number description: Issued document net amount with rivalsa nullable: true amount_cassa: type: number description: Issued document cassa amount nullable: true taxable_amount: type: number nullable: true description: Issued document taxable amount not_taxable_amount: type: number description: Issued document not taxable amount nullable: true amount_vat: type: number description: Issued document total vat amount nullable: true amount_gross: type: number description: Issued document total gross amount nullable: true taxable_amount_withholding_tax: type: number description: Issued document Taxable withholding tax amount nullable: true amount_withholding_tax: type: number description: Issued document withholding tax amount nullable: true taxable_amount_other_withholding_tax: type: number description: Issued document other withholding tax taxable amount nullable: true amount_other_withholding_tax: type: number description: Issued document other withholding tax amount nullable: true stamp_duty: type: number description: Issued document stamp duty value [0 if not present]. nullable: true amount_due: type: number description: Issued document total amount due nullable: true is_enasarco_maximal_exceeded: type: boolean nullable: true description: Is enasarco maximal excedeed payments_sum: type: number description: Issued document payments sum nullable: true vat_list: title: VatList type: object additionalProperties: type: object title: VatItem properties: amount_net: type: number nullable: true description: Vat item net amount amount_vat: type: number nullable: true description: Vat item vat amount description: Issued document vat list nullable: true examples: example-1: value: data: amount_net: 68.18 amount_rivalsa: 13.64 amount_net_with_rivalsa: 81.82 taxable_amount: 81.82 vat_list: '10': amount_net: 81.82 amount_vat: 8.18 amount_vat: 8.18 amount_gross: 90 amount_due: 90 amount_due_discount: 0 payments_sum: 75 UploadIssuedDocumentAttachmentResponse: description: Attachment Token. content: application/json: schema: title: UploadIssuedDocumentAttachmentResponse type: object properties: data: title: AttachmentData type: object properties: attachment_token: type: string example: YmMyNWYxYzIwMTU3N2Y4ZGE3ZjZiMzg5OWY0ODNkZDQveXl5LmRvYw description: Uploaded attachment token. nullable: true nullable: true examples: example-1: value: data: attachment_token: YmMyNWYxYzIwMTU3N2Y4ZGE3ZjZiMzg5OWY0ODNkZDQveXl5LmRvYw GetIssuedDocumentPreCreateInfoResponse: description: Pre-create info. content: application/json: schema: title: GetIssuedDocumentPreCreateInfoResponse type: object properties: data: type: object title: IssuedDocumentPreCreateInfo properties: numerations: title: Numeration type: object additionalProperties: type: object title: NumerationItem additionalProperties: type: integer description: Issued document numerations dn_numerations: title: Numeration type: object additionalProperties: type: object title: NumerationItem additionalProperties: type: integer description: Issued document delivery note numerations default_values: type: object description: Issued document default values nullable: true properties: default_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true dn_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true ai_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true notes: type: string description: Default notes. nullable: true rivalsa: type: number description: Default rivalsa percentage. nullable: true cassa: type: number description: Default cassa percentage. nullable: true withholding_tax: type: number description: Default withholding tax percentage. nullable: true withholding_tax_taxable: type: number description: Default withholding tax taxable percentage. nullable: true other_withholding_tax: type: number description: Default other withholding tax percentage. nullable: true use_gross_prices: type: boolean description: Use gross price by default. nullable: true payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true extra_data_default_values: type: object nullable: true description: Issued document extra data default values properties: ts_communication: type: boolean nullable: true ts_tipo_spesa: type: string nullable: true ts_flag_tipo_spesa: type: integer nullable: true ts_pagamento_tracciato: type: boolean nullable: true items_default_values: type: object nullable: true description: Issued document items default values properties: vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true countries_list: type: array description: Countries list nullable: true items: type: string currencies_list: type: array description: Currencies list nullable: true items: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true templates_list: type: array description: Document templates list nullable: true items: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true dn_templates_list: type: array description: Delivery note templates list nullable: true items: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true ai_templates_list: type: array description: Accompanying invoice templates list nullable: true items: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true payment_methods_list: type: array description: Payment methods list nullable: true items: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true payment_accounts_list: type: array description: Payment accounts list nullable: true items: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true vat_types_list: type: array description: Vat types list nullable: true items: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true languages_list: type: array description: Languages list nullable: true items: type: object title: Language properties: code: type: string description: Language code nullable: true name: type: string description: Language extended name nullable: true nullable: true examples: example-1: value: data: numerations: '2018': AB123: 2 '2019': '123': null '2020': ABC: 2 '2021': rec123: 2 dn_numerations: '2017': '': 1000 '2018': '': 112 '2019': '': 526 '2020': '': 11 '2021': '': 110 default_values: template: id: 111 type: standard name: Light Smoke dn_template: id: 222 type: delivery_note name: DDT 1 ai_template: id: 333 type: accompanying_invoice name: FT Accompagnatoria 1 notes: '' rivalsa: 0 cassa: 0 withholding_tax: 0 withholding_tax_taxable: 100 other_withholding_tax: 0 use_gross_prices: false payment_method: id: 123321 name: Bonifico bancario is_default: true details: - title: Banca description: Indesa - title: IBAN description: IT17QA12345600000003498936 - title: Intestatario description: Mario Rossi bank_iban: IT17QA12345600000003498936 bank_name: Indesa bank_beneficiary: Mario Rossi ei_payment_method: MP05 show_payment_method: true ei_cassa_type: null ei_withholding_tax_causal: B ei_other_withholding_tax_type: null ei_other_withholding_tax_causal: null ei_default_document_type: TD01 extra_data_default_values: ts_communication: false ts_tipo_spesa: SR ts_flag_tipo_spesa: 0 ts_pagamento_tracciato: false items_default_values: vat: id: 0 value: 22 description: '' notes: '' e_invoice: true ei_type: '0' ei_description: '' is_disabled: false editable: false default: true countries_list: - Italia - Afghanistan - Albania - Algeria - Andorra - Angola - Anguilla - Antartide - Antigua e Barbuda - Antille Olandesi - Arabia Saudita - Argentina - Armenia - Aruba - Australia - Austria - Azerbaigian - Bahamas - Bahrain - Bangladesh - Barbados - Belgio - Belize - Benin - Bermuda - Bhutan - Bielorussia - Bolivia - Bosnia ed Erzegovina - Botswana - Brasile - Brunei - Bulgaria - Burkina Faso - Burundi - Cambogia - Camerun - Canada - Capo Verde - Ciad - Cile - Cina - Cipro - Città del Vaticano - Colombia - Comore - Corea del Nord - Corea del Sud - Costa Rica - Costa d'Avorio - Croazia - Cuba - Danimarca - Dominica - Ecuador - Egitto - El Salvador - Emirati Arabi Uniti - Eritrea - Estonia - Etiopia - Fiji - Filippine - Finlandia - Francia - Gabon - Gambia - Georgia - Georgia del Sud e isole Sandwich - Germania - Ghana - Giamaica - Giappone - Gibilterra - Gibuti - Giordania - Grecia - Grenada - Groenlandia - Guadalupa - Guam - Guatemala - Guernsey - Channel Islands - Guinea - Guinea Equatoriale - Guinea-Bissau - Guyana - Guyana Francese - Haiti - Heard Island e McDonald Islands - Honduras - Hong Kong - India - Indonesia - Iran - Iraq - Irlanda - Islanda - Isola Bouvet - Isola Christmas - Isola di Man - Isola Norfolk - Isole Canarie (Spagna) - Isole Cayman - Isole Cocos e Keeling - Isole Cook - Isole Falkland - Isole Fær Øer - Isole Marianne Settentrionali - Isole Marshall - Isole Minori Esterne degli USA - Isole Pitcairn - Isole Salomone - Isole Vergini Americane - Isole Vergini Britanniche - Isole Åland - Israele - Jersey - Channel Islands - Kazakistan - Kenia - Kirghizistan - Kiribati - Kosovo - Kuwait - Laos - Lesotho - Lettonia - Libano - Liberia - Libia - Liechtenstein - Lituania - Lussemburgo - Macao - Macedonia - Macedonia del Nord - Madagascar - Malawi - Malaysia - Maldive - Mali - Malta - Marocco - Martinica - Mauritania - Mauritius - Mayotte - Messico - Micronesia - Moldavia - Monaco - Mongolia - Montenegro - Montserrat - Mozambico - Myanmar - Namibia - Nauru - Nepal - Nicaragua - Niger - Nigeria - Niue - Norvegia - Nuova Caledonia - Nuova Zelanda - Oman - Paesi Bassi - Pakistan - Palau - Panama - Papua Nuova Guinea - Paraguay - Perù - Polinesia Francese - Polonia - Porto Rico - Portogallo - Qatar - Regno Unito - Repubblica Ceca - Repubblica Centrafricana - Repubblica Democratica del Congo - Repubblica Dominicana - Repubblica del Congo - Riunione - Romania - Ruanda - Russia - Sahara Occidentale - Saint Barthelemy - Saint Kitts e Nevis - Saint Pierre e Miquelon - Saint Vincent e Grenadine - Samoa - Samoa Americane - San Marino - Sant'Elena - Santa Lucia - Senegal - Serbia - Seychelles - Sierra Leone - Singapore - Siria - Slovacchia - Slovenia - Somalia - Spagna - Sri Lanka - Stato di Palestina - Stati Uniti - Sudafrica - Sud Sudan - Sudan - Suriname - Svalbard e Jan Mayen - Svezia - Svizzera - Swaziland - São Tomé e Príncipe - Tagikistan - Taiwan - Tanzania - Terre australi e ant. francesi - Terr. Britannico dell'Oc. Ind. - Thailandia - Timor Est - Togo - Tokelau - Tonga - Trinidad e Tobago - Tunisia - Turchia - Turkmenistan - Turks e Caicos - Tuvalu - Ucraina - Uganda - Ungheria - Uruguay - Uzbekistan - Vanuatu - Venezuela - Vietnam - Wallis e Futuna - Yemen - Zambia - Zimbabwe currencies_list: - id: AED symbol: AED html_symbol: AED exchange_rate: '4.09500' - id: ALL symbol: ALL html_symbol: ALL exchange_rate: '121.50000' - id: AUD symbol: AUD html_symbol: AUD exchange_rate: '1.62094' - id: AZN symbol: AZN html_symbol: AZN exchange_rate: '2.00130' - id: BGN symbol: лв html_symbol: BGN exchange_rate: '1.95583' - id: BRL symbol: R$ html_symbol: R$ exchange_rate: '4.50410' - id: BYN symbol: BYN html_symbol: BYN exchange_rate: '2.41000' - id: CAD symbol: CAD html_symbol: CAD exchange_rate: '1.49841' - id: CFA symbol: CFA html_symbol: CFA exchange_rate: '656.68000' - id: CHF symbol: Fr. html_symbol: Fr. exchange_rate: '1.12559' - id: CNY symbol: CNY html_symbol: CNY exchange_rate: '7.70160' - id: CRC symbol: ₡ html_symbol: '₡' exchange_rate: '659.17000' - id: CZK symbol: Kč html_symbol: CZK exchange_rate: '25.80600' - id: DKK symbol: kr. html_symbol: kr. exchange_rate: '7.46750' - id: DOP symbol: DOP html_symbol: DOP exchange_rate: '56.50000' - id: DZD symbol: DZD html_symbol: DZD exchange_rate: '134.28300' - id: EGP symbol: EGP html_symbol: EGP exchange_rate: '18.98030' - id: EUR symbol: € html_symbol: '€' exchange_rate: '1.00000' - id: GBP symbol: £ html_symbol: '£' exchange_rate: '0.88096' - id: GHS symbol: GHS html_symbol: GHS exchange_rate: '5.45834' - id: HKD symbol: HK$ html_symbol: HK$ exchange_rate: '8.75450' - id: HRK symbol: HRK html_symbol: HRK exchange_rate: '7.42640' - id: HUF symbol: HUF html_symbol: HUF exchange_rate: '326.24000' - id: ILS symbol: ₪ html_symbol: '₪' exchange_rate: '4.02680' - id: INR symbol: INR html_symbol: INR exchange_rate: '77.76050' - id: ISK symbol: ISK html_symbol: ISK exchange_rate: '135.94600' - id: JPY symbol: ¥ html_symbol: '¥' exchange_rate: '123.05800' - id: KRW symbol: KRW html_symbol: KRW exchange_rate: '1329.20000' - id: MAD symbol: MAD html_symbol: MAD exchange_rate: '10.78900' - id: MKD symbol: MKD html_symbol: MKD exchange_rate: '61.36700' - id: MXN symbol: Mex$ html_symbol: Mex$ exchange_rate: '21.17900' - id: MYR symbol: MYR html_symbol: MYR exchange_rate: '4.67310' - id: NGN symbol: NGN html_symbol: NGN exchange_rate: '405.17000' - id: NIS symbol: NIS html_symbol: NIS exchange_rate: '4020.00000' - id: NOK symbol: kr html_symbol: kr exchange_rate: '9.76270' - id: NZD symbol: NZD html_symbol: NZD exchange_rate: '1.71687' - id: OMR symbol: OMR html_symbol: OMR exchange_rate: '0.42950' - id: PEN symbol: PEN html_symbol: PEN exchange_rate: '3.73400' - id: PLN symbol: zł html_symbol: PLN exchange_rate: '4.30330' - id: QAR symbol: QAR html_symbol: QAR exchange_rate: '4.06270' - id: RON symbol: RON html_symbol: RON exchange_rate: '4.66891' - id: RSD symbol: RSD html_symbol: RSD exchange_rate: '117.39414' - id: RUB symbol: ₽ html_symbol: '₽' exchange_rate: '71.70370' - id: SAR symbol: SAR html_symbol: SAR exchange_rate: '4.18520' - id: SEK symbol: SEK html_symbol: SEK exchange_rate: '10.73374' - id: SGD symbol: SGD html_symbol: SGD exchange_rate: '1.53800' - id: THB symbol: THB html_symbol: THB exchange_rate: '35.56400' - id: TND symbol: TND html_symbol: TND exchange_rate: '3.34010' - id: TRY symbol: TRY html_symbol: TRY exchange_rate: '6.81590' - id: TWD symbol: TWD html_symbol: TWD exchange_rate: '35.14200' - id: UAH symbol: UAH html_symbol: UAH exchange_rate: '29.31490' - id: USD symbol: $ html_symbol: '$' exchange_rate: '1.11570' - id: VND symbol: ₫ html_symbol: '₫' exchange_rate: '26100.00000' - id: ZAR symbol: R html_symbol: R exchange_rate: '16.03080' templates_list: - id: 10 name: New Standard S1 - id: 11 name: New Standard S2 - id: 12 name: New Professionisti P1 - id: 13 name: New Buste - id: 14 name: New Professionisti P2 - id: 101 name: Clear lines - id: 106 name: Minimalist - id: 107 name: Squared - id: 108 name: Modern - id: 150 name: Bright Colors - id: 681 name: Modern Spese di trasporto - id: 682 name: Modern ciao - id: 2821 name: Light Smoke - id: 2823 name: IDEAVERDE - id: 2824 name: LS problem - id: 2825 name: Light Smoke 2nd CASSA - id: 2826 name: LIGHT NUOVO - id: 2827 name: STAND dn_templates_list: - id: 660 name: DDT 1 - id: 680 name: DDT Prova ai_templates_list: - id: 663 name: FT Accompagnatoria 1 payment_methods_list: - id: 555 name: Rimessa diretta is_default: false details: [] bank_iban: null bank_name: null bank_beneficiary: null ei_payment_method: null - id: 123321 name: Bonifico bancario is_default: true details: - title: Banca description: Indesa - title: IBAN description: IT17QA12345600000003498936 - title: Intestatario description: Mario Rossi bank_iban: IT17QA12345600000003498936 bank_name: Indesa bank_beneficiary: Mario Rossi ei_payment_method: MP05 payment_accounts_list: - id: 21 name: Indesa - Carta conto - id: 287 name: Bonifico_Bancario vat_types_list: - id: 1409 value: 15 description: 'ALIQUOTA #1234#' ei_type: '0' is_disabled: false - id: 1332 value: 0 description: Non imp. art. 17 c. 6 lett. A TER DPR 633/72 ei_type: '0' is_disabled: false measures_list: - pezzi - kg - litri - ore - giorni - km - mesi languages_list: - code: it name: Italiano - code: en name: Inglese - code: de name: Tedesco - code: fr name: Francese - code: es name: Spagnolo - code: pt name: Portoghese - code: el name: Greco - code: pl name: Polacco - code: sl name: Sloveno ei_structure: FatturaElettronicaHeader: idx: 1 children: DatiTrasmissione: idx: 1 children: ContattiTrasmittente: idx: 5 children: Telefono: idx: 1 type: text length: - 5 - 12 Email: idx: 2 type: text length: - 7 - 256 CedentePrestatore: idx: 2 children: DatiAnagrafici: idx: 1 children: Anagrafica: idx: 3 children: CodEORI: idx: 5 type: text length: - 13 - 17 AlboProfessionale: idx: 4 type: text length: - 1 - 60 ProvinciaAlbo: idx: 5 type: text length: 2 NumeroIscrizioneAlbo: idx: 6 type: text length: - 1 - 60 DataIscrizioneAlbo: idx: 7 type: date length: 10 Sede: idx: 2 children: NumeroCivico: idx: 2 type: text length: - 1 - 8 StabileOrganizzazione: idx: 3 children: Indirizzo: idx: 1 type: text length: - 1 - 60 NumeroCivico: idx: 2 type: text length: - 1 - 8 CAP: idx: 3 type: text length: 5 Comune: idx: 4 type: text length: - 1 - 60 Provincia: idx: 5 type: text length: 2 Nazione: idx: 6 type: text length: 2 Contatti: idx: 5 children: Telefono: idx: 1 type: text length: - 5 - 12 Fax: idx: 2 type: text length: - 5 - 12 Email: idx: 3 type: text length: - 7 - 256 RiferimentoAmministrazione: idx: 6 type: text length: - 1 - 20 CessionarioCommittente: idx: 4 children: DatiAnagrafici: idx: 1 children: Anagrafica: idx: 3 children: Nome: idx: 2 type: text length: - 2 - 50 Cognome: idx: 3 type: text length: - 2 - 50 Titolo: idx: 4 type: text length: - 2 - 10 CodEORI: idx: 5 type: text length: - 13 - 17 StabileOrganizzazione: idx: 3 children: Indirizzo: idx: 1 type: text length: - 1 - 60 NumeroCivico: idx: 2 type: text length: - 1 - 8 CAP: idx: 3 type: text length: 5 Comune: idx: 4 type: text length: - 1 - 60 Provincia: idx: 5 type: text length: 2 Nazione: idx: 6 type: text length: 2 RappresentanteFiscale: idx: 4 children: IdFiscaleIVA: idx: 1 children: IdPaese: idx: 1 type: text length: 2 IdCodice: idx: 2 type: text length: - 1 - 28 Denominazione: idx: 2 type: text length: - 1 - 80 Nome: idx: 3 type: text length: - 1 - 60 Cognome: idx: 4 type: text length: - 1 - 60 FatturaElettronicaBody: idx: 2 children: DatiGenerali: idx: 1 children: DatiGeneraliDocumento: idx: 1 children: TipoDocumento: idx: 1 type: select options: TD01: TD01 - fattura TD02: TD02 - acconto/anticipo su fattura TD03: TD03 - acconto/anticipo su parcella TD04: TD04 - nota di credito TD05: TD05 - nota di debito TD06: TD06 - parcella TD16: >- TD16 - integrazione fattura reverse charge interno TD17: >- TD17 - integrazione/autofattura per acquisto servizi dall'estero TD18: >- TD18 - integrazione per acquisto di beni intracomunitari TD19: >- TD19 - integrazione/autofattura per acquisto di beni ex art.17 c.2 DPR 633/72 TD20: >- TD20 - autofattura per regolarizzazione e integrazione delle fatture (art.6 c.8 d.lgs. 471/97 o art.46 c.5 D.L. 331/93) TD21: TD21 - autofattura per splafonamento TD22: TD22 - estrazione beni da Deposito IVA TD23: >- TD23 - estrazione beni da Deposito IVA con versamento dell'IVA TD24: >- TD24 - fattura differita di cui all'art. 21, comma 4, lett. a) TD25: >- TD25 - fattura differita di cui all'art. 21, comma 4, terzo periodo, lett. b) TD26: >- TD26 - cessione di beni ammortizzabili e per passaggi interni (ex art.36 DPR 633/72) TD27: >- TD27 - fattura per autoconsumo o per cessioni gratuite senza rivalsa Arrotondamento: idx: 10 type: text format: decimal length: - 4 - 15 Causale: idx: 11 array: true type: text length: - 1 - 200 Art73: idx: 12 type: select options: SI: Si DatiOrdineAcquisto: idx: 2 array: true children: RiferimentoNumeroLinea: idx: 1 type: text array: true length: - 1 - 4 IdDocumento: idx: 2 type: text length: - 1 - 20 Data: idx: 3 type: date length: 10 NumItem: idx: 4 type: text length: - 1 - 20 CodiceCommessaConvenzione: idx: 5 type: text length: - 1 - 100 CodiceCUP: idx: 6 type: text length: - 1 - 15 CodiceCIG: idx: 7 type: text length: - 1 - 15 DatiContratto: idx: 3 array: true children: RiferimentoNumeroLinea: idx: 1 type: text array: true length: - 1 - 4 IdDocumento: idx: 2 type: text length: - 1 - 20 Data: idx: 3 type: date length: 10 NumItem: idx: 4 type: text length: - 1 - 20 CodiceCommessaConvenzione: idx: 5 type: text length: - 1 - 100 CodiceCUP: idx: 6 type: text length: - 1 - 15 CodiceCIG: idx: 7 type: text length: - 1 - 15 DatiConvenzione: idx: 4 array: true children: RiferimentoNumeroLinea: idx: 1 type: text array: true length: - 1 - 4 IdDocumento: idx: 2 type: text length: - 1 - 20 Data: idx: 3 type: date length: 10 NumItem: idx: 4 type: text length: - 1 - 20 CodiceCommessaConvenzione: idx: 5 type: text length: - 1 - 100 CodiceCUP: idx: 6 type: text length: - 1 - 15 CodiceCIG: idx: 7 type: text length: - 1 - 15 DatiRicezione: idx: 5 array: true children: RiferimentoNumeroLinea: idx: 1 type: text array: true length: - 1 - 4 IdDocumento: idx: 2 type: text length: - 1 - 20 Data: idx: 3 type: date length: 10 NumItem: idx: 4 type: text length: - 1 - 20 CodiceCommessaConvenzione: idx: 5 type: text length: - 1 - 100 CodiceCUP: idx: 6 type: text length: - 1 - 15 CodiceCIG: idx: 7 type: text length: - 1 - 15 DatiFattureCollegate: idx: 6 array: true children: RiferimentoNumeroLinea: idx: 1 type: text array: true length: - 1 - 4 IdDocumento: idx: 2 type: text length: - 1 - 20 Data: idx: 3 type: date length: 10 NumItem: idx: 4 type: text length: - 1 - 20 CodiceCommessaConvenzione: idx: 5 type: text length: - 1 - 100 CodiceCUP: idx: 6 type: text length: - 1 - 15 CodiceCIG: idx: 7 type: text length: - 1 - 15 DatiSAL: idx: 7 array: true children: RiferimentoFase: idx: 1 type: text length: - 1 - 3 DatiDDT: idx: 8 array: true children: NumeroDDT: idx: 1 type: text length: - 1 - 20 DataDDT: idx: 2 type: date length: 10 RiferimentoNumeroLinea: idx: 3 type: text array: true length: - 1 - 4 DatiTrasporto: idx: 9 children: DatiAnagraficiVettore: idx: 1 children: IdFiscaleIVA: idx: 1 children: IdPaese: idx: 1 type: text length: 2 IdCodice: idx: 2 type: text length: - 1 - 28 CodiceFiscale: idx: 2 type: text length: - 11 - 16 Anagrafica: idx: 3 children: Denominazione: idx: 1 type: text length: - 1 - 80 Nome: idx: 2 type: text length: - 1 - 60 Cognome: idx: 3 type: text length: - 1 - 60 Titolo: idx: 4 type: text length: - 2 - 10 CodEORI: idx: 5 type: text length: - 13 - 17 NumeroLicenzaGuida: idx: 4 type: text length: - 1 - 20 MezzoTrasporto: idx: 2 type: text length: - 1 - 80 CausaleTrasporto: idx: 3 type: text length: - 1 - 100 NumeroColli: idx: 4 type: text length: - 1 - 4 DataInizioTrasporto: idx: 10 type: date length: 10 TipoResa: idx: 11 type: text length: 3 IndirizzoResa: idx: 12 children: Indirizzo: idx: 1 type: text length: - 1 - 60 NumeroCivico: idx: 2 type: text length: - 1 - 8 CAP: idx: 3 type: text length: 5 Comune: idx: 4 type: text length: - 1 - 60 Provincia: idx: 5 type: text length: 2 Nazione: idx: 6 type: text length: 2 DatiPagamento: idx: '4' children: CondizioniPagamento: idx: 1 type: select options: TP01: Pagamento a rate TP02: Pagamento completo TP03: Anticipo ei_item_structure: DettaglioLinee: idx: 2.2.1 children: NumeroLinea: idx: 1 type: text length: - 1 - 4 TipoCessionePrestazione: idx: 2 type: select options: SC: sconto PR: premio AB: abbuono AC: spesa accessoria CodiceArticolo: idx: 3 array: true children: CodiceTipo: idx: 1 type: text length: - 1 - 35 CodiceValore: idx: 2 type: text length: - 1 - 35 DataInizioPeriodo: idx: 7 type: date length: 10 DataFinePeriodo: idx: 8 type: date length: 10 RiferimentoAmministrazione: idx: 15 type: text length: - 1 - 20 AltriDatiGestionali: idx: 16 array: true children: TipoDato: idx: 1 type: text length: - 1 - 10 RiferimentoTesto: idx: 2 type: text length: - 1 - 60 RiferimentoNumero: idx: 3 type: text format: decimal length: - 4 - 21 RiferimentoData: idx: 4 type: date length: 10 ei_payment_structure: DettaglioPagamento: idx: 2.4.2 children: DataRiferimentoTerminiPagamento: idx: 3 type: date length: 10 GiorniTerminiPagamento: idx: 4 type: text length: - 1 - 3 DataScadenzaPagamento: idx: 5 type: date length: 10 ABI: idx: 14 type: text length: 5 CAB: idx: 15 type: text length: 5 BIC: idx: 16 type: text length: - 8 - 11 DataDecorrenzaPenale: idx: 20 type: date length: 10 documents_type_info: TD01: self_own_invoice: false self_supplier_invoice: true description: TD01 - fattura description_self_invoice: TD01 - fattura in nome e per conto TD02: self_own_invoice: true self_supplier_invoice: true description: TD02 - acconto/anticipo su fattura TD03: self_own_invoice: true self_supplier_invoice: true description: TD03 - acconto/anticipo su parcella TD04: self_own_invoice: true self_supplier_invoice: true description: TD04 - nota di credito TD05: self_own_invoice: true self_supplier_invoice: true description: TD05 - nota di debito TD06: self_own_invoice: true self_supplier_invoice: true description: TD06 - parcella TD16: self_own_invoice: false self_supplier_invoice: true description: TD16 - integrazione fattura reverse charge interno TD17: self_own_invoice: false self_supplier_invoice: true description: >- TD17 - integrazione/autofattura per acquisto servizi dall'estero TD18: self_own_invoice: false self_supplier_invoice: true description: TD18 - integrazione per acquisto di beni intracomunitari TD19: self_own_invoice: false self_supplier_invoice: true description: >- TD19 - integrazione/autofattura per acquisto di beni ex art.17 c.2 DPR 633/72 TD20: self_own_invoice: false self_supplier_invoice: true description: >- TD20 - autofattura per regolarizzazione e integrazione delle fatture (art.6 c.8 d.lgs. 471/97 o art.46 c.5 D.L. 331/93) TD21: self_own_invoice: true self_supplier_invoice: false description: TD21 - autofattura per splafonamento TD22: self_own_invoice: false self_supplier_invoice: true description: TD22 - estrazione beni da Deposito IVA TD23: self_own_invoice: false self_supplier_invoice: true description: >- TD23 - estrazione beni da Deposito IVA con versamento dell'IVA TD24: self_own_invoice: true self_supplier_invoice: true description: >- TD24 - fattura differita di cui all'art. 21, comma 4, lett. a) TD25: self_own_invoice: true self_supplier_invoice: true description: >- TD25 - fattura differita di cui all'art. 21, comma 4, terzo periodo, lett. b) TD26: self_own_invoice: true self_supplier_invoice: true description: >- TD26 - cessione di beni ammortizzabili e per passaggi interni (ex art.36 DPR 633/72) TD27: self_own_invoice: true self_supplier_invoice: true description: >- TD27 - fattura per autoconsumo o per cessioni gratuite senza rivalsa ei_regime_info: RF01: Ordinario RF02: Contribuenti minimi (art.1, c.96-117, L. 244/07) RF04: >- Agricoltura e attività connesse e pesca (artt.34 e 34-bis, DPR 633/72) RF05: Vendita sali e tabacchi (art.74, c.1, DPR. 633/72) RF06: Commercio fiammiferi (art.74, c.1, DPR 633/72) RF07: Editoria (art.74, c.1, DPR 633/72) RF08: >- Gestione servizi telefonia pubblica (art.74, c.1, DPR 633/72) RF09: >- Rivendita documenti di trasporto pubblico e di sosta (art.74, c.1, DPR 633/72) RF10: >- Intrattenimenti, giochi e altre attività di cui alla tariffa allegata al DPR 640/72 (art.74, c.6, DPR 633/72) RF11: Agenzie viaggi e turismo (art.74-ter, DPR 633/72) RF12: Agriturismo (art.5, c.2, L. 413/91) RF13: Vendite a domicilio (art.25-bis, c.6, DPR 600/73) RF14: >- Rivendita beni usati, oggetti d’arte, d’antiquariato o da collezione (art.36, DL 41/95) RF15: >- Agenzie di vendite all’asta di oggetti d'arte, antiquariato o da collezione (art.40-bis, DL 41/95) RF16: IVA per cassa P.A. (art.6, c.5, DPR 633/72) RF17: IVA per cassa (art. 32-bis, DL 83/2012) RF18: Altro RF19: Regime forfettario (art.1, c.54-89, L. 190/2014) ei_cassa_type_info: '': Nessuna cassa previdenziale TC01: >- Cassa nazionale previdenza e assistenza avvocati e procuratori legali TC02: Cassa previdenza dottori commercialisti TC03: Cassa previdenza e assistenza geometri TC04: >- Cassa nazionale previdenza e assistenza ingegneri e architetti liberi professionisti TC05: Cassa nazionale del notariato TC06: >- Cassa nazionale previdenza e assistenza ragionieri e periti commerciali TC07: >- Ente nazionale assistenza agenti e rappresentanti di commercio (ENASARCO) TC08: >- Ente nazionale previdenza e assistenza consulenti del lavoro (ENPACL) TC09: Ente nazionale previdenza e assistenza medici (ENPAM) TC10: Ente nazionale previdenza e assistenza farmacisti (ENPAF) TC11: Ente nazionale previdenza e assistenza veterinari (ENPAV) TC12: >- Ente nazionale previdenza e assistenza impiegati dell'agricoltura (ENPAIA) TC13: >- Fondo previdenza impiegati imprese di spedizione e agenzie marittime TC14: Istituto nazionale previdenza giornalisti italiani (INPGI) TC15: >- Opera nazionale assistenza orfani sanitari italiani (ONAOSI) TC16: >- Cassa autonoma assistenza integrativa giornalisti italiani (CASAGIT) TC17: >- Ente previdenza periti industriali e periti industriali laureati (EPPI) TC18: Ente previdenza e assistenza pluricategoriale (EPAP) TC19: Ente nazionale previdenza e assistenza biologi (ENPAB) TC20: >- Ente nazionale previdenza e assistenza professione infermieristica (ENPAPI) TC21: Ente nazionale previdenza e assistenza psicologi (ENPAP) TC22: INPS ei_causal_payment_info: '': Nessuna ritenuta A: >- Prestazioni di lavoro autonomo rientranti nell'esercizio di arte o professione abituale B: >- Utilizzazione economica, da parte dell'autore o dell'inventore, di opere dell'ingegno, di brevetti industriali e di processi, formule o informazioni relativi ad esperienze acquisite in campo industriale, commerciale o scientifico C: >- Utili derivanti da contratti di associazione in partecipazione e da contratti di cointeressenza, quando l'apporto è costituito esclusivamente dalla prestazione di lavoro D: >- Utili spettanti ai soci promotori ed ai soci fondatori delle società di capitali E: >- Levata di protesti cambiari da parte dei segretari comunali G: >- Indennità corrisposte per la cessazione di attività sportiva professionale H: >- Indennità corrisposte per la cessazione dei rapporti di agenzia delle persone fisiche e delle società di persone con esclusione delle somme maturate entro il 31 dicembre 2003, già imputate per competenza e tassate come reddito d'impresa I: >- Indennità corrisposte per la cessazione da funzioni notarili L: >- Redditi derivanti dall'utilizzazione economica di opere dell'ingegno, di brevetti industriali e di processi, formule e informazioni relativi a esperienze acquisite in campo industriale, commerciale o scientifico, che sono percepiti dagli aventi causa a titolo gratuito (ad es. eredi e legatari dell'autore e inventore) L1: >- Redditi derivanti dall'utilizzazione economica di opere dell'ingegno, di brevetti industriali e di processi, formule e informazioni relativi a esperienze acquisite in campo industriale, commerciale o scientifico, che sono percepiti da soggetti che abbiano acquistato a titolo oneroso i diritti alla loro utilizzazione M: Prestazioni di lavoro autonomo non esercitate abitualmente M1: >- Redditi derivanti dall'assunzione di obblighi di fare, di non fare o permettere M2: >- Prestazioni di lavoro autonomo non esercitate abitualmente per le quali sussiste l'obbligo di iscrizione alla Gestione Separata ENPAPI 'N': "Indennità di trasferta, rimborso forfettario di spese, premi e compensi erogati: \x96 nell'esercizio diretto di attività sportive dilettantistiche; in relazione a rapporti di collaborazione coordinata e continuativa di carattere amministrativo-gestionale di natura non professionale resi a favore di società e associazioni sportive dilettantistiche e di cori, bande e filodrammatiche da parte del direttore e dei collaboratori tecnici;" O: >- Prestazioni di lavoro autonomo non esercitate abitualmente, obblighi di fare, di non fare o permettere, per le quali non sussiste l'obbligo di iscrizione alla gestione separata (Circ. INPS n. 104/2001) O1: >- Redditi derivanti dall’assunzione di obblighi di fare, di non fare o permettere, per le quali non sussiste l'obbligo di iscrizione alla gestione separata (Circ. INPS n. 104/2001) P: >- compensi corrisposti a soggetti non residenti privi di stabile organizzazione per l'uso o la concessione in uso di attrezzature industriali, commerciali o scientifiche che si trovano nel territorio dello Stato ovvero a società svizzere o stabili organizzazioni di società svizzere che possiedono i requisiti di cui all'art. 15, comma 2 dell'Accordo tra la Comunità europea e la Confederazione svizzera del 26 ottobre 2004 (pubblicato in G.U.C.E. del 29 dicembre 2004 n. L385/30) Q: >- Provvigioni corrisposte ad agente o rappresentante di commercio monomandatario R: >- Provvigioni corrisposte ad agente o rappresentante di commercio plurimandatario S: Provvigioni corrisposte a commissionario T: Provvigioni corrisposte a mediatore U: Provvigioni corrisposte a procacciatore di affari V: >- Provvigioni corrisposte a incaricato per le vendite a domicilio; provvigioni corrisposte a incaricato per la vendita porta a porta e per la vendita ambulante di giornali quotidiani e periodici (L. 25 febbraio 1987, n. 67) V1: >- Redditi derivanti da attività commerciali non esercitate abitualmente (ad esempio, provvigioni corrisposte per prestazioni occasionali ad agente o rappresentante di commercio, mediatore, procacciatore d'affari) W: >- Corrispettivi erogati nell'anno corrente per prestazioni relative a contratti d'appalto cui si sono resi applicabili le disposizioni contenute nell'art. 25-ter del D.P.R. n. 600 del 29 settembre 1973 X: >- Canoni corrisposti nel 2004 da società o enti residenti ovvero da stabili organizzazioni di società estere di cui all'art. 26-quater, comma 1, lett. a) e b) del D.P.R. 600 del 29 settembre 1973, a società o stabili organizzazioni di società, situate in altro stato membro dell'Unione Europea in presenza dei requisiti di cui al citato art. 26-quater, del D.P.R. 600 del 29 settembre 1973, per i quali è stato effettuato, nell'anno 2006, il rimborso della ritenuta ai sensi dell'art. 4 del D.Lgs. 30 maggio 2005 n. 143 'Y': >- Canoni corrisposti dal 1° gennaio 2005 al 26 luglio 2005 da società o enti residenti ovvero da stabili organizzazioni di società estere di cui all'art. 26-quater, comma 1, lett. a) e b) del D.P.R. n. 600 del 29 settembre 1973, asocietà o stabili organizzazioni di società, situate in altro stato membro dell'Unione Europea in presenza dei requisiti di cui al citato art. 26-quater, del D.P.R. n. 600 del 29 settembre 1973, per i quali è stato effettuato, nell'anno 2006, il rimborso della ritenuta ai sensi dell'art. 4 del D.Lgs. 30 maggio 2005 n. 143 ZO: Titolo diverso dai precedenti ei_withholding_type_info: '': Nessuna ritenuta RT01: Ritenuta di acconto persone fisiche RT02: Ritenuta di acconto persone giuridiche RT03: Contributo INPS RT04: Contributo ENASARCO RT05: Contributo ENPAM RT06: Altro contributo previdenziale use_e_invoice: true GetEmailDataResponse: description: EmailData content: application/json: schema: title: GetEmailDataResponse type: object properties: data: type: object title: EmailData properties: recipient_email: type: string description: Email recipient nullable: true default_sender_email: type: object description: >- Default sender email. (Other emails can be found in **sender_emails_list**) nullable: true properties: id: type: integer nullable: true description: Default sender email id email: type: string description: Default sender email address nullable: true sender_emails_list: type: array description: List of all emails from which the document can be sent nullable: true items: title: SenderEmail type: object properties: id: type: integer description: Sender email id nullable: true email: type: string description: Sender email address nullable: true cc_email: type: string description: Email cc [by default is the logged company email] nullable: true subject: type: string description: Email subject nullable: true body: type: string description: Email body nullable: true document_exists: type: boolean description: Document exists if it is not a delivery note nullable: true delivery_note_exists: type: boolean description: Document is a delivery note nullable: true attachment_exists: type: boolean description: Document has attachment nullable: true accompanying_invoice_exists: type: boolean description: Document has accompanying invoice nullable: true default_attach_pdf: type: boolean nullable: true description: Attach document pdf nullable: true examples: example-1: value: data: recipient_email: mary.red@example.com default_sender_email: id: 0 email: no-reply@fattureincloud.it sender_emails_list: - id: 0 email: no-reply@fattureincloud.it - id: 888 email: mariorossi@fattureincloud.it cc_email: m.rossi@exxample.com subject: Nostra pro forma nr. 1 body: >- Gentile Mario Rossi,
per vedere la nostra pro forma di o per scaricarne una copia in versione PDF prema sul bottone sottoastante.

{{allegati}}

Cordiali saluti,
Mario Rossi document_exists: true delivery_note_exists: false attachment_exists: false accompanying_invoice_exists: false SendEInvoiceResponse: description: Example response content: application/json: schema: title: SendEInvoiceResponse type: object properties: data: type: object properties: name: type: string description: Response message. nullable: true date: type: string description: E-invoice sent date. nullable: true nullable: true examples: example-1: value: data: name: CARICATO date: '2021-08-23 10:38:03' VerifyEInvoiceXmlResponse: description: Example response content: application/json: schema: title: VerifyEInvoiceXmlResponse type: object properties: data: type: object properties: success: type: boolean description: Determine if the invoice XML is valid. nullable: true nullable: true examples: example-1: value: data: success: true VerifyEInvoiceXmlErrorResponse: description: Example response content: application/json: schema: title: VerifyEInvoiceXmlErrorResponse type: object properties: error: type: object nullable: true properties: message: type: string nullable: true validation_result: type: object nullable: true properties: xml_errors: type: array nullable: true items: type: string extra: type: object nullable: true properties: errors: type: array nullable: true items: type: string ListReceivedDocumentsResponse: description: Results list. content: application/json: schema: title: ListReceivedDocumentsResponse allOf: - title: Pagination type: object description: '' properties: current_page: type: integer description: Current page number. nullable: true first_page_url: type: string format: uri description: First page url. nullable: true from: type: integer nullable: true description: First result of the page. last_page: type: integer description: Last page number. nullable: true last_page_url: type: string format: uri description: Last page url. nullable: true next_page_url: type: string format: uri nullable: true description: Next page url path: type: string format: uri description: Request path. nullable: true per_page: type: integer description: Number of result per page. nullable: true prev_page_url: type: string format: uri nullable: true description: Previous page url. to: type: integer nullable: true description: Last result of the page. total: type: integer description: Total number of results nullable: true - title: ListReceivedDocumentsResponsePage type: object properties: data: type: array items: type: object title: ReceivedDocument properties: id: type: integer nullable: true description: Received document id type: title: ReceivedDocumentType type: string default: expense enum: - expense - passive_credit_note - passive_delivery_note description: Received document type entity: title: Entity type: object properties: id: type: integer nullable: true description: Entity id code: type: string example: '123' description: Entity code nullable: true name: type: string example: Rossi S.r.l. description: Entity name nullable: true type: title: EntityType type: string nullable: true default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name nullable: true last_name: type: string description: Entity last name nullable: true contact_person: type: string nullable: true description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Entitity address street nullable: true address_postal_code: type: string example: '24010' nullable: true description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city nullable: true address_province: type: string example: BG description: Entity address province nullable: true address_extra: type: string description: Entity address extra info nullable: true country: type: string example: Italia description: Entity country nullable: true country_iso: type: string example: Italia description: Entity country iso code nullable: true email: type: string example: mario.rossi@example.it description: Entity email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email nullable: true phone: type: string nullable: true description: Entity phone fax: type: string nullable: true description: Entity fax notes: type: string description: Entity extra nullable: true default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name nullable: true bank_iban: type: string description: |- [Only for client] Client bank iban nullable: true bank_swift_code: type: string description: |- [Only for client] Client bank swift code nullable: true shipping_address: type: string description: |- [Only for client] Client Shipping address nullable: true e_invoice: type: boolean description: |- [Only for client] Use e-invoices. nullable: true ei_code: type: string description: |- [Only for client] E-invoices code. nullable: true has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. nullable: true intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Entity creation date updated_at: type: string nullable: true description: Entity last update date date: type: string description: Received document date [defaults to today's date] format: date nullable: true category: type: string nullable: true description: Received document category description: type: string description: Received document description nullable: true amount_net: type: number description: Received document total net amount nullable: true amount_vat: type: number description: Received document total vat amount nullable: true amount_withholding_tax: type: number description: Received document withholding tax amount nullable: true amount_other_withholding_tax: type: number description: Received document other withholding tax amount nullable: true amount_gross: type: number description: |- [Read Only] Received document total gross amount nullable: true readOnly: true amortization: type: number description: Received document amortization value nullable: true rc_center: type: string description: Received document revenue center nullable: true invoice_number: type: string description: Received document invoice number nullable: true is_marked: type: boolean nullable: true description: Received document is marked is_detailed: type: boolean nullable: true description: Received document has items e_invoice: type: boolean description: |- [Read Only] Received document is an e-invoice nullable: true next_due_date: type: string nullable: true description: |- [Read Only] Received document date of the next not paid payment format: date readOnly: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true tax_deductibility: type: number description: Received document tax deducibility percentage nullable: true vat_deductibility: type: number description: Received document vat deducibility percentage nullable: true items_list: type: array nullable: true items: title: ReceivedDocumentItemsListItem type: object properties: id: type: integer description: Received document item id nullable: true product_id: type: integer description: Received document product id nullable: true code: type: string description: Received document item product code nullable: true name: type: string description: Received document item product name nullable: true measure: type: string description: Received document item measure nullable: true net_price: type: number description: Received document item product net price nullable: true category: type: string description: Received document item product category nullable: true qty: type: number description: Received document item quantity nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true stock: type: number description: >- Received document item product number of items in stock nullable: true payments_list: type: array nullable: true items: title: ReceivedDocumentPaymentsListItem type: object properties: id: type: integer description: Received document payment id nullable: true amount: type: number description: Received document payment total amount nullable: true due_date: type: string description: Due date format: date nullable: true paid_date: type: string description: Received document payment paid date format: date nullable: true payment_terms: type: object nullable: true properties: days: type: integer description: >- Received document payment number of days by which the payment must be made nullable: true type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type status: type: string description: Received document payment status nullable: true payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Received document url of the attached file nullable: true readOnly: true attachment_preview_url: type: string description: |- [Temporary] [Read Only] Received document url of the attachment preview nullable: true readOnly: true auto_calculate: type: boolean description: >- Received document total items amount and total payments amount can differ if this field is set to false nullable: true attachment_token: type: string nullable: true description: >- [Write Only] Received document attachment token returned by POST /received_documents/attachment locked: type: boolean nullable: true description: Received Document can't be edited created_at: type: string nullable: true description: Received document creation date updated_at: type: string nullable: true description: Received document last update date nullable: true description: '' examples: example-1: value: current_page: 1 data: - id: 12345 type: expense description: Soggiorno di lavoro amortization: 1 rc_center: '' invoice_number: '' is_marked: false is_detailed: false e_invoice: false created_at: '2021-08-15 14:02:02' updated_at: '2021-08-15 14:02:02' entity: id: 111 name: Hotel Rubino Palace date: '2021-08-15' next_due_date: '2021-08-15' currency: id: EUR exchange_rate: '1.00000' symbol: € amount_net: 592 amount_vat: 0 amount_gross: 592 amount_withholding_tax: 0 amount_other_withholding_tax: 0 tax_deductibility: 50 vat_deductibility: 100 items_list: null payments_list: - amount: 592 due_date: '2021-08-15' paid_date: '2021-08-15' id: 777 payment_terms: days: 0 type: standard status: paid payment_account: id: 222 name: Contanti virtual: false attachment_url: spesa_ger5i783t45hu6ti.pdf attachment_preview_url: null extra_data: null - id: 12346 type: expense description: Assicurazione RCA iamortization: 1 rc_center: '' invoice_number: '' is_marked: false is_detailed: false e_invoice: false created_at: '2021-08-09 14:02:02' updated_at: '2021-08-09 14:02:02' entity: id: 89 name: Indesa Assicurazioni S.P.A. date: '2021-08-08' next_due_date: '2021-08-08' currency: id: EUR exchange_rate: '1.00000' symbol: € amount_net: 645.69 amount_vat: 0 amount_gross: 645.69 amount_withholding_tax: 0 amount_other_withholding_tax: 0 tax_deductibility: 50 vat_deductibility: 100 items_list: null payments_list: - amount: 645.69 due_date: '2021-08-08' paid_date: '2021-08-08' id: 999 payment_terms: days: 0 type: standard status: paid payment_account: id: 333 name: Carta conto virtual: false attachment_url: spesa_gjsd567e5hu6ti.pdf attachment_preview_url: null extra_data: null first_page_url: page=1 from: 1 last_page: 2 last_page_url: page=2 next_page_url: page=2 path: received_documents per_page: 50 prev_page_url: null to: 50 total: 123 CreateReceivedDocumentResponse: description: Document created. content: application/json: schema: title: CreateReceivedDocumentResponse type: object properties: data: type: object title: ReceivedDocument properties: id: type: integer nullable: true description: Received document id type: title: ReceivedDocumentType type: string default: expense enum: - expense - passive_credit_note - passive_delivery_note description: Received document type entity: title: Entity type: object properties: id: type: integer nullable: true description: Entity id code: type: string example: '123' description: Entity code nullable: true name: type: string example: Rossi S.r.l. description: Entity name nullable: true type: title: EntityType type: string nullable: true default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name nullable: true last_name: type: string description: Entity last name nullable: true contact_person: type: string nullable: true description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Entitity address street nullable: true address_postal_code: type: string example: '24010' nullable: true description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city nullable: true address_province: type: string example: BG description: Entity address province nullable: true address_extra: type: string description: Entity address extra info nullable: true country: type: string example: Italia description: Entity country nullable: true country_iso: type: string example: Italia description: Entity country iso code nullable: true email: type: string example: mario.rossi@example.it description: Entity email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email nullable: true phone: type: string nullable: true description: Entity phone fax: type: string nullable: true description: Entity fax notes: type: string description: Entity extra nullable: true default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name nullable: true bank_iban: type: string description: |- [Only for client] Client bank iban nullable: true bank_swift_code: type: string description: |- [Only for client] Client bank swift code nullable: true shipping_address: type: string description: |- [Only for client] Client Shipping address nullable: true e_invoice: type: boolean description: |- [Only for client] Use e-invoices. nullable: true ei_code: type: string description: |- [Only for client] E-invoices code. nullable: true has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. nullable: true intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Entity creation date updated_at: type: string nullable: true description: Entity last update date date: type: string description: Received document date [defaults to today's date] format: date nullable: true category: type: string nullable: true description: Received document category description: type: string description: Received document description nullable: true amount_net: type: number description: Received document total net amount nullable: true amount_vat: type: number description: Received document total vat amount nullable: true amount_withholding_tax: type: number description: Received document withholding tax amount nullable: true amount_other_withholding_tax: type: number description: Received document other withholding tax amount nullable: true amount_gross: type: number description: |- [Read Only] Received document total gross amount nullable: true readOnly: true amortization: type: number description: Received document amortization value nullable: true rc_center: type: string description: Received document revenue center nullable: true invoice_number: type: string description: Received document invoice number nullable: true is_marked: type: boolean nullable: true description: Received document is marked is_detailed: type: boolean nullable: true description: Received document has items e_invoice: type: boolean description: |- [Read Only] Received document is an e-invoice nullable: true next_due_date: type: string nullable: true description: |- [Read Only] Received document date of the next not paid payment format: date readOnly: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true tax_deductibility: type: number description: Received document tax deducibility percentage nullable: true vat_deductibility: type: number description: Received document vat deducibility percentage nullable: true items_list: type: array nullable: true items: title: ReceivedDocumentItemsListItem type: object properties: id: type: integer description: Received document item id nullable: true product_id: type: integer description: Received document product id nullable: true code: type: string description: Received document item product code nullable: true name: type: string description: Received document item product name nullable: true measure: type: string description: Received document item measure nullable: true net_price: type: number description: Received document item product net price nullable: true category: type: string description: Received document item product category nullable: true qty: type: number description: Received document item quantity nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true stock: type: number description: >- Received document item product number of items in stock nullable: true payments_list: type: array nullable: true items: title: ReceivedDocumentPaymentsListItem type: object properties: id: type: integer description: Received document payment id nullable: true amount: type: number description: Received document payment total amount nullable: true due_date: type: string description: Due date format: date nullable: true paid_date: type: string description: Received document payment paid date format: date nullable: true payment_terms: type: object nullable: true properties: days: type: integer description: >- Received document payment number of days by which the payment must be made nullable: true type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type status: type: string description: Received document payment status nullable: true payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Received document url of the attached file nullable: true readOnly: true attachment_preview_url: type: string description: |- [Temporary] [Read Only] Received document url of the attachment preview nullable: true readOnly: true auto_calculate: type: boolean description: >- Received document total items amount and total payments amount can differ if this field is set to false nullable: true attachment_token: type: string nullable: true description: >- [Write Only] Received document attachment token returned by POST /received_documents/attachment locked: type: boolean nullable: true description: Received Document can't be edited created_at: type: string nullable: true description: Received document creation date updated_at: type: string nullable: true description: Received document last update date nullable: true description: '' examples: example-1: value: data: id: 12345 type: expense description: Soggiorno di lavoro amortization: 1 rc_center: '' invoice_number: '' is_marked: false is_detailed: false e_invoice: false created_at: '2021-08-15 14:02:02' updated_at: '2021-08-15 14:02:02' entity: id: 111 name: Hotel Rubino Palace date: '2021-08-15' next_due_date: '2021-08-15' currency: id: EUR exchange_rate: '1.00000' symbol: € amount_net: 592 amount_vat: 0 amount_gross: 592 amount_withholding_tax: 0 amount_other_withholding_tax: 0 tax_deductibility: 50 vat_deductibility: 100 items_list: null payments_list: - amount: 592 due_date: '2021-08-15' paid_date: '2021-08-15' id: 777 payment_terms: days: 0 type: standard status: paid payment_account: id: 222 name: Contanti virtual: false attachment_url: spesa_ger5i783t45hu6ti.pdf attachment_preview_url: null extra_data: null GetReceivedDocumentResponse: description: Document details. content: application/json: schema: title: GetReceivedDocumentResponse type: object properties: data: type: object title: ReceivedDocument properties: id: type: integer nullable: true description: Received document id type: title: ReceivedDocumentType type: string default: expense enum: - expense - passive_credit_note - passive_delivery_note description: Received document type entity: title: Entity type: object properties: id: type: integer nullable: true description: Entity id code: type: string example: '123' description: Entity code nullable: true name: type: string example: Rossi S.r.l. description: Entity name nullable: true type: title: EntityType type: string nullable: true default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name nullable: true last_name: type: string description: Entity last name nullable: true contact_person: type: string nullable: true description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Entitity address street nullable: true address_postal_code: type: string example: '24010' nullable: true description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city nullable: true address_province: type: string example: BG description: Entity address province nullable: true address_extra: type: string description: Entity address extra info nullable: true country: type: string example: Italia description: Entity country nullable: true country_iso: type: string example: Italia description: Entity country iso code nullable: true email: type: string example: mario.rossi@example.it description: Entity email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email nullable: true phone: type: string nullable: true description: Entity phone fax: type: string nullable: true description: Entity fax notes: type: string description: Entity extra nullable: true default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name nullable: true bank_iban: type: string description: |- [Only for client] Client bank iban nullable: true bank_swift_code: type: string description: |- [Only for client] Client bank swift code nullable: true shipping_address: type: string description: |- [Only for client] Client Shipping address nullable: true e_invoice: type: boolean description: |- [Only for client] Use e-invoices. nullable: true ei_code: type: string description: |- [Only for client] E-invoices code. nullable: true has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. nullable: true intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Entity creation date updated_at: type: string nullable: true description: Entity last update date date: type: string description: Received document date [defaults to today's date] format: date nullable: true category: type: string nullable: true description: Received document category description: type: string description: Received document description nullable: true amount_net: type: number description: Received document total net amount nullable: true amount_vat: type: number description: Received document total vat amount nullable: true amount_withholding_tax: type: number description: Received document withholding tax amount nullable: true amount_other_withholding_tax: type: number description: Received document other withholding tax amount nullable: true amount_gross: type: number description: |- [Read Only] Received document total gross amount nullable: true readOnly: true amortization: type: number description: Received document amortization value nullable: true rc_center: type: string description: Received document revenue center nullable: true invoice_number: type: string description: Received document invoice number nullable: true is_marked: type: boolean nullable: true description: Received document is marked is_detailed: type: boolean nullable: true description: Received document has items e_invoice: type: boolean description: |- [Read Only] Received document is an e-invoice nullable: true next_due_date: type: string nullable: true description: |- [Read Only] Received document date of the next not paid payment format: date readOnly: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true tax_deductibility: type: number description: Received document tax deducibility percentage nullable: true vat_deductibility: type: number description: Received document vat deducibility percentage nullable: true items_list: type: array nullable: true items: title: ReceivedDocumentItemsListItem type: object properties: id: type: integer description: Received document item id nullable: true product_id: type: integer description: Received document product id nullable: true code: type: string description: Received document item product code nullable: true name: type: string description: Received document item product name nullable: true measure: type: string description: Received document item measure nullable: true net_price: type: number description: Received document item product net price nullable: true category: type: string description: Received document item product category nullable: true qty: type: number description: Received document item quantity nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true stock: type: number description: >- Received document item product number of items in stock nullable: true payments_list: type: array nullable: true items: title: ReceivedDocumentPaymentsListItem type: object properties: id: type: integer description: Received document payment id nullable: true amount: type: number description: Received document payment total amount nullable: true due_date: type: string description: Due date format: date nullable: true paid_date: type: string description: Received document payment paid date format: date nullable: true payment_terms: type: object nullable: true properties: days: type: integer description: >- Received document payment number of days by which the payment must be made nullable: true type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type status: type: string description: Received document payment status nullable: true payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Received document url of the attached file nullable: true readOnly: true attachment_preview_url: type: string description: |- [Temporary] [Read Only] Received document url of the attachment preview nullable: true readOnly: true auto_calculate: type: boolean description: >- Received document total items amount and total payments amount can differ if this field is set to false nullable: true attachment_token: type: string nullable: true description: >- [Write Only] Received document attachment token returned by POST /received_documents/attachment locked: type: boolean nullable: true description: Received Document can't be edited created_at: type: string nullable: true description: Received document creation date updated_at: type: string nullable: true description: Received document last update date nullable: true description: '' examples: example-1: value: data: id: 12345 type: expense description: Soggiorno di lavoro amortization: 1 rc_center: '' invoice_number: '' is_marked: false is_detailed: false e_invoice: false created_at: '2021-08-15 14:02:02' updated_at: '2021-08-15 14:02:02' entity: id: 111 name: Hotel Rubino Palace date: '2021-08-15' next_due_date: '2021-08-15' currency: id: EUR exchange_rate: '1.00000' symbol: € amount_net: 592 amount_vat: 0 amount_gross: 592 amount_withholding_tax: 0 amount_other_withholding_tax: 0 tax_deductibility: 50 vat_deductibility: 100 items_list: null payments_list: - amount: 592 due_date: '2021-08-15' paid_date: '2021-08-15' id: 777 payment_terms: days: 0 type: standard status: paid payment_account: id: 222 name: Contanti virtual: false attachment_url: spesa_ger5i783t45hu6ti.pdf attachment_preview_url: null extra_data: null ModifyReceivedDocumentResponse: description: Modified document. content: application/json: schema: title: ModifyReceivedDocumentResponse type: object properties: data: type: object title: ReceivedDocument properties: id: type: integer nullable: true description: Received document id type: title: ReceivedDocumentType type: string default: expense enum: - expense - passive_credit_note - passive_delivery_note description: Received document type entity: title: Entity type: object properties: id: type: integer nullable: true description: Entity id code: type: string example: '123' description: Entity code nullable: true name: type: string example: Rossi S.r.l. description: Entity name nullable: true type: title: EntityType type: string nullable: true default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name nullable: true last_name: type: string description: Entity last name nullable: true contact_person: type: string nullable: true description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Entitity address street nullable: true address_postal_code: type: string example: '24010' nullable: true description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city nullable: true address_province: type: string example: BG description: Entity address province nullable: true address_extra: type: string description: Entity address extra info nullable: true country: type: string example: Italia description: Entity country nullable: true country_iso: type: string example: Italia description: Entity country iso code nullable: true email: type: string example: mario.rossi@example.it description: Entity email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email nullable: true phone: type: string nullable: true description: Entity phone fax: type: string nullable: true description: Entity fax notes: type: string description: Entity extra nullable: true default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name nullable: true bank_iban: type: string description: |- [Only for client] Client bank iban nullable: true bank_swift_code: type: string description: |- [Only for client] Client bank swift code nullable: true shipping_address: type: string description: |- [Only for client] Client Shipping address nullable: true e_invoice: type: boolean description: |- [Only for client] Use e-invoices. nullable: true ei_code: type: string description: |- [Only for client] E-invoices code. nullable: true has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. nullable: true intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Entity creation date updated_at: type: string nullable: true description: Entity last update date date: type: string description: Received document date [defaults to today's date] format: date nullable: true category: type: string nullable: true description: Received document category description: type: string description: Received document description nullable: true amount_net: type: number description: Received document total net amount nullable: true amount_vat: type: number description: Received document total vat amount nullable: true amount_withholding_tax: type: number description: Received document withholding tax amount nullable: true amount_other_withholding_tax: type: number description: Received document other withholding tax amount nullable: true amount_gross: type: number description: |- [Read Only] Received document total gross amount nullable: true readOnly: true amortization: type: number description: Received document amortization value nullable: true rc_center: type: string description: Received document revenue center nullable: true invoice_number: type: string description: Received document invoice number nullable: true is_marked: type: boolean nullable: true description: Received document is marked is_detailed: type: boolean nullable: true description: Received document has items e_invoice: type: boolean description: |- [Read Only] Received document is an e-invoice nullable: true next_due_date: type: string nullable: true description: |- [Read Only] Received document date of the next not paid payment format: date readOnly: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true tax_deductibility: type: number description: Received document tax deducibility percentage nullable: true vat_deductibility: type: number description: Received document vat deducibility percentage nullable: true items_list: type: array nullable: true items: title: ReceivedDocumentItemsListItem type: object properties: id: type: integer description: Received document item id nullable: true product_id: type: integer description: Received document product id nullable: true code: type: string description: Received document item product code nullable: true name: type: string description: Received document item product name nullable: true measure: type: string description: Received document item measure nullable: true net_price: type: number description: Received document item product net price nullable: true category: type: string description: Received document item product category nullable: true qty: type: number description: Received document item quantity nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true stock: type: number description: >- Received document item product number of items in stock nullable: true payments_list: type: array nullable: true items: title: ReceivedDocumentPaymentsListItem type: object properties: id: type: integer description: Received document payment id nullable: true amount: type: number description: Received document payment total amount nullable: true due_date: type: string description: Due date format: date nullable: true paid_date: type: string description: Received document payment paid date format: date nullable: true payment_terms: type: object nullable: true properties: days: type: integer description: >- Received document payment number of days by which the payment must be made nullable: true type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type status: type: string description: Received document payment status nullable: true payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Received document url of the attached file nullable: true readOnly: true attachment_preview_url: type: string description: |- [Temporary] [Read Only] Received document url of the attachment preview nullable: true readOnly: true auto_calculate: type: boolean description: >- Received document total items amount and total payments amount can differ if this field is set to false nullable: true attachment_token: type: string nullable: true description: >- [Write Only] Received document attachment token returned by POST /received_documents/attachment locked: type: boolean nullable: true description: Received Document can't be edited created_at: type: string nullable: true description: Received document creation date updated_at: type: string nullable: true description: Received document last update date nullable: true description: '' examples: example-1: value: data: id: 12345 type: expense description: Soggiorno di lavoro amortization: 1 rc_center: '' invoice_number: '' is_marked: false is_detailed: false e_invoice: false created_at: '2021-08-15 14:02:02' updated_at: '2021-08-15 14:02:02' entity: id: 111 name: Hotel Rubino Palace date: '2021-08-15' next_due_date: '2021-08-15' currency: id: EUR exchange_rate: '1.00000' symbol: € amount_net: 592 amount_vat: 0 amount_gross: 592 amount_withholding_tax: 0 amount_other_withholding_tax: 0 tax_deductibility: 50 vat_deductibility: 100 items_list: null payments_list: - amount: 592 due_date: '2021-08-15' paid_date: '2021-08-15' id: 777 payment_terms: days: 0 type: standard status: paid payment_account: id: 222 name: Contanti virtual: false attachment_url: spesa_ger5i783t45hu6ti.pdf attachment_preview_url: null extra_data: null GetNewReceivedDocumentTotalsResponse: description: Document Totals. content: application/json: schema: title: GetNewReceivedDocumentTotalsResponse type: object properties: data: type: object title: ReceivedDocumentTotals properties: amount_net: type: number description: Received document total net amount nullable: true amount_vat: type: number description: Received document total vat amount nullable: true amount_gross: type: number description: Received document total gross amount nullable: true amount_withholding_tax: type: number description: Received document withholding tax amount nullable: true amount_other_withholding_tax: type: number description: Received document other withholding tax amount nullable: true amount_due: type: number description: Received document total amount due nullable: true payments_sum: type: number description: Received document payments sum nullable: true nullable: true description: '' examples: example-1: value: data: amount_net: 592 amount_vat: 10 amount_gross: 602 amount_withholding_tax: 0 amount_other_withholding_tax: 0 amount_due: 602 payments_sum: 592 GetExistingReceivedDocumentTotalsResponse: description: Document Totals. content: application/json: schema: title: GetExistingReceivedDocumentTotalsResponse type: object properties: data: type: object title: ReceivedDocumentTotals properties: amount_net: type: number description: Received document total net amount nullable: true amount_vat: type: number description: Received document total vat amount nullable: true amount_gross: type: number description: Received document total gross amount nullable: true amount_withholding_tax: type: number description: Received document withholding tax amount nullable: true amount_other_withholding_tax: type: number description: Received document other withholding tax amount nullable: true amount_due: type: number description: Received document total amount due nullable: true payments_sum: type: number description: Received document payments sum nullable: true nullable: true description: '' examples: example-1: value: data: amount_net: 592 amount_vat: 20 amount_gross: 612 amount_withholding_tax: 0 amount_other_withholding_tax: 0 amount_due: 612 payments_sum: 592 UploadReceivedDocumentAttachmentResponse: description: Attachment Token. content: application/json: schema: title: UploadReceivedDocumentAttachmentResponse type: object properties: data: title: AttachmentData type: object properties: attachment_token: type: string example: YmMyNWYxYzIwMTU3N2Y4ZGE3ZjZiMzg5OWY0ODNkZDQveXl5LmRvYw description: Uploaded attachment token. nullable: true nullable: true examples: example-1: value: data: attachment_token: YmMyNWYxYzIwMTU3N212ABCDZjZiMzg5OWY0ODNkZDQveXl5LmRvYw GetReceivedDocumentPreCreateInfoResponse: description: Pre-create info content: application/json: schema: title: GetReceivedDocumentPreCreateInfoResponse type: object description: '' properties: data: title: ReceivedDocumentInfo type: object properties: default_values: type: object description: Received document default values nullable: true properties: detailed: type: boolean nullable: true items_default_values: type: object description: Received document items default values nullable: true properties: vat: type: number nullable: true description: Vat default value countries_list: type: array nullable: true description: Countries list items: type: string currencies_list: type: array nullable: true description: Currencies list items: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true categories_list: type: array nullable: true description: Categories list items: type: string payment_accounts_list: type: array nullable: true description: Payments accounts list items: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true vat_types_list: type: array nullable: true description: Vat types list items: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true nullable: true examples: example-1: value: data: default_values: detailed: false items_default_values: vat: null countries_list: - Italia - Afghanistan - Albania - Algeria - Andorra - Angola - Anguilla - Antartide - Antigua e Barbuda - Antille Olandesi - Arabia Saudita - Argentina - Armenia - Aruba - Australia - Austria - Azerbaigian - Bahamas - Bahrain - Bangladesh - Barbados - Belgio - Belize - Benin - Bermuda - Bhutan - Bielorussia - Bolivia - Bosnia ed Erzegovina - Botswana - Brasile - Brunei - Bulgaria - Burkina Faso - Burundi - Cambogia - Camerun - Canada - Capo Verde - Ciad - Cile - Cina - Cipro - Città del Vaticano - Colombia - Comore - Corea del Nord - Corea del Sud - Costa Rica - Costa d'Avorio - Croazia - Cuba - Danimarca - Dominica - Ecuador - Egitto - El Salvador - Emirati Arabi Uniti - Eritrea - Estonia - Etiopia - Fiji - Filippine - Finlandia - Francia - Gabon - Gambia - Georgia - Georgia del Sud e isole Sandwich - Germania - Ghana - Giamaica - Giappone - Gibilterra - Gibuti - Giordania - Grecia - Grenada - Groenlandia - Guadalupa - Guam - Guatemala - Guernsey - Channel Islands - Guinea - Guinea Equatoriale - Guinea-Bissau - Guyana - Guyana Francese - Haiti - Heard Island e McDonald Islands - Honduras - Hong Kong - India - Indonesia - Iran - Iraq - Irlanda - Islanda - Isola Bouvet - Isola Christmas - Isola di Man - Isola Norfolk - Isole Canarie (Spagna) - Isole Cayman - Isole Cocos e Keeling - Isole Cook - Isole Falkland - Isole Fær Øer - Isole Marianne Settentrionali - Isole Marshall - Isole Minori Esterne degli USA - Isole Pitcairn - Isole Salomone - Isole Vergini Americane - Isole Vergini Britanniche - Isole Åland - Israele - Jersey - Channel Islands - Kazakistan - Kenia - Kirghizistan - Kiribati - Kosovo - Kuwait - Laos - Lesotho - Lettonia - Libano - Liberia - Libia - Liechtenstein - Lituania - Lussemburgo - Macao - Macedonia - Macedonia del Nord - Madagascar - Malawi - Malaysia - Maldive - Mali - Malta - Marocco - Martinica - Mauritania - Mauritius - Mayotte - Messico - Micronesia - Moldavia - Monaco - Mongolia - Montenegro - Montserrat - Mozambico - Myanmar - Namibia - Nauru - Nepal - Nicaragua - Niger - Nigeria - Niue - Norvegia - Nuova Caledonia - Nuova Zelanda - Oman - Paesi Bassi - Pakistan - Palau - Panama - Papua Nuova Guinea - Paraguay - Perù - Polinesia Francese - Polonia - Porto Rico - Portogallo - Qatar - Regno Unito - Repubblica Ceca - Repubblica Centrafricana - Repubblica Democratica del Congo - Repubblica Dominicana - Repubblica del Congo - Riunione - Romania - Ruanda - Russia - Sahara Occidentale - Saint Barthelemy - Saint Kitts e Nevis - Saint Pierre e Miquelon - Saint Vincent e Grenadine - Samoa - Samoa Americane - San Marino - Sant'Elena - Santa Lucia - Senegal - Serbia - Seychelles - Sierra Leone - Singapore - Siria - Slovacchia - Slovenia - Somalia - Spagna - Sri Lanka - Stato di Palestina - Stati Uniti - Sudafrica - Sud Sudan - Sudan - Suriname - Svalbard e Jan Mayen - Svezia - Svizzera - Swaziland - São Tomé e Príncipe - Tagikistan - Taiwan - Tanzania - Terre australi e ant. francesi - Terr. Britannico dell'Oc. Ind. - Thailandia - Timor Est - Togo - Tokelau - Tonga - Trinidad e Tobago - Tunisia - Turchia - Turkmenistan - Turks e Caicos - Tuvalu - Ucraina - Uganda - Ungheria - Uruguay - Uzbekistan - Vanuatu - Venezuela - Vietnam - Wallis e Futuna - Yemen - Zambia - Zimbabwe currencies_list: - id: AED symbol: AED html_symbol: AED exchange_rate: '4.09500' - id: ALL symbol: ALL html_symbol: ALL exchange_rate: '121.50000' - id: AUD symbol: AUD html_symbol: AUD exchange_rate: '1.62094' - id: AZN symbol: AZN html_symbol: AZN exchange_rate: '2.00130' - id: BGN symbol: лв html_symbol: BGN exchange_rate: '1.95583' - id: BRL symbol: R$ html_symbol: R$ exchange_rate: '4.50410' - id: BYN symbol: BYN html_symbol: BYN exchange_rate: '2.41000' - id: CAD symbol: CAD html_symbol: CAD exchange_rate: '1.49841' - id: CFA symbol: CFA html_symbol: CFA exchange_rate: '656.68000' - id: CHF symbol: Fr. html_symbol: Fr. exchange_rate: '1.12559' - id: CNY symbol: CNY html_symbol: CNY exchange_rate: '7.70160' - id: CRC symbol: ₡ html_symbol: '₡' exchange_rate: '659.17000' - id: CZK symbol: Kč html_symbol: CZK exchange_rate: '25.80600' - id: DKK symbol: kr. html_symbol: kr. exchange_rate: '7.46750' - id: DOP symbol: DOP html_symbol: DOP exchange_rate: '56.50000' - id: DZD symbol: DZD html_symbol: DZD exchange_rate: '134.28300' - id: EGP symbol: EGP html_symbol: EGP exchange_rate: '18.98030' - id: EUR symbol: € html_symbol: '€' exchange_rate: '1.00000' - id: GBP symbol: £ html_symbol: '£' exchange_rate: '0.88096' - id: GHS symbol: GHS html_symbol: GHS exchange_rate: '5.45834' - id: HKD symbol: HK$ html_symbol: HK$ exchange_rate: '8.75450' - id: HRK symbol: HRK html_symbol: HRK exchange_rate: '7.42640' - id: HUF symbol: HUF html_symbol: HUF exchange_rate: '326.24000' - id: ILS symbol: ₪ html_symbol: '₪' exchange_rate: '4.02680' - id: INR symbol: INR html_symbol: INR exchange_rate: '77.76050' - id: ISK symbol: ISK html_symbol: ISK exchange_rate: '135.94600' - id: JPY symbol: ¥ html_symbol: '¥' exchange_rate: '123.05800' - id: KRW symbol: KRW html_symbol: KRW exchange_rate: '1329.20000' - id: MAD symbol: MAD html_symbol: MAD exchange_rate: '10.78900' - id: MKD symbol: MKD html_symbol: MKD exchange_rate: '61.36700' - id: MXN symbol: Mex$ html_symbol: Mex$ exchange_rate: '21.17900' - id: MYR symbol: MYR html_symbol: MYR exchange_rate: '4.67310' - id: NGN symbol: NGN html_symbol: NGN exchange_rate: '405.17000' - id: NIS symbol: NIS html_symbol: NIS exchange_rate: '4020.00000' - id: NOK symbol: kr html_symbol: kr exchange_rate: '9.76270' - id: NZD symbol: NZD html_symbol: NZD exchange_rate: '1.71687' - id: OMR symbol: OMR html_symbol: OMR exchange_rate: '0.42950' - id: PEN symbol: PEN html_symbol: PEN exchange_rate: '3.73400' - id: PLN symbol: zł html_symbol: PLN exchange_rate: '4.30330' - id: QAR symbol: QAR html_symbol: QAR exchange_rate: '4.06270' - id: RON symbol: RON html_symbol: RON exchange_rate: '4.66891' - id: RSD symbol: RSD html_symbol: RSD exchange_rate: '117.39414' - id: RUB symbol: ₽ html_symbol: '₽' exchange_rate: '71.70370' - id: SAR symbol: SAR html_symbol: SAR exchange_rate: '4.18520' - id: SEK symbol: SEK html_symbol: SEK exchange_rate: '10.73374' - id: SGD symbol: SGD html_symbol: SGD exchange_rate: '1.53800' - id: THB symbol: THB html_symbol: THB exchange_rate: '35.56400' - id: TND symbol: TND html_symbol: TND exchange_rate: '3.34010' - id: TRY symbol: TRY html_symbol: TRY exchange_rate: '6.81590' - id: TWD symbol: TWD html_symbol: TWD exchange_rate: '35.14200' - id: UAH symbol: UAH html_symbol: UAH exchange_rate: '29.31490' - id: USD symbol: $ html_symbol: '$' exchange_rate: '1.11570' - id: VND symbol: ₫ html_symbol: '₫' exchange_rate: '26100.00000' - id: ZAR symbol: R html_symbol: R exchange_rate: '16.03080' categories_list: - Auto - Telefono e internet - Assicurazioni e quote - Auto ed altri veicoli - Computer e accessori - Server e hosting - merda - Prva - Farina etc. - Cat - Cibo - gigi d'asti - banca d'asti - Varie - zzzzz - ooooo - aaa - ffff - www - bbb payment_accounts_list: - id: 111 name: Indesa - carta conto - id: 222 name: Contanti - id: 333 name: Bonifico_Bancario vat_types_list: - id: 1334 value: 0 description: Non imp. art. 17 c. 6 DPR 633/72 e s.m.i. is_disabled: false - id: 1333 value: 0 description: Non sogg. art. 74 c. 7 e 8 DPR 633/72 is_disabled: false - id: 1332 value: 0 description: Non imp. art. 17 c. 6 lett. A TER DPR 633/72 is_disabled: false - id: 1020 value: 0 description: PA Non imp art. 2 is_disabled: false - id: 1018 value: 0 description: Aliq. 22% reverse charge is_disabled: false - id: 1015 value: 22 description: Speciale prova is_disabled: false - id: 1014 value: 0 description: Ai sensi dellarticolo 123 is_disabled: false - id: 1013 value: 0 description: Non imponibile art. 8 lett. A DPR 633/72 is_disabled: false - id: 1010 value: 0 description: NON IMPONIBILE IVA EX ART. 8 COMMA 1 LETT.A is_disabled: false - id: 1009 value: 20 description: Aliquota 20% is_disabled: false - id: 1008 value: 0 description: Non imp. art. 41 D.L. 427/93 is_disabled: false - id: 1007 value: 0 description: Non imp. art. 71 DPR 633/72 is_disabled: false - id: 1006 value: 0 description: Escl. art. 15 DPR 633/72 is_disabled: false - id: 1004 value: 0 description: Non imp. art. 1 L. 244/2007 is_disabled: false - id: 1003 value: 0 description: Non imp. art. 8 DPR 633/72 is_disabled: false - id: 1002 value: 0 description: Omaggi art. 2 c. 2 n. 4 DPR 633/72 is_disabled: false - id: 1000 value: 0 description: art.26 COMMA' 3 DPR 633/72 is_disabled: false - id: 7 value: 0 description: Regime dei minimi is_disabled: false - id: 9 value: 0 description: Fuori campo IVA is_disabled: false - id: 10 value: 0 description: Oper. non soggetta, art.7 ter is_disabled: false - id: 11 value: 0 description: Inversione contabile, art.7 ter is_disabled: false - id: 12 value: 0 description: Non Imponibile is_disabled: false - id: 13 value: 0 description: Non Imp. Art.8 is_disabled: false - id: 14 value: 0 description: Non Imp. Art.9 1C is_disabled: false - id: 15 value: 0 description: Non Imp. Art.14 Legge 537/93 is_disabled: false - id: 16 value: 0 description: Non Imp. Art.41 D.P.R. 331/93 is_disabled: false - id: 17 value: 0 description: Non Imp. Art.72, D.P.R. 633/72 is_disabled: false - id: 18 value: 0 description: Non Imp. Art.74 quotidiani/libri is_disabled: false - id: 19 value: 0 description: Escluso Art.10 is_disabled: false - id: 20 value: 0 description: Escluso Art.13 5C DPR 633/72 is_disabled: false - id: 21 value: 0 description: Escluso Art.15 is_disabled: false - id: 23 value: 0 description: Escluso Art.74 ter D.P.R. 633/72 is_disabled: false - id: 24 value: 0 description: Escluso Art.10 comma 1 is_disabled: false - id: 25 value: 0 description: Escluso Art.10 comma 20 is_disabled: false - id: 26 value: 0 description: Non Imp. Art.9 is_disabled: false - id: 27 value: 0 description: Escluso Art.10 n.27 D.P.R 633/72 is_disabled: false - id: 30 value: 0 description: Regime del margine art.36 41/95 is_disabled: false - id: 31 value: 0 description: Escluso Art.3 comma 4 D.P.R 633/72 is_disabled: false - id: 32 value: 0 description: Escluso Art.15/1c D.P.R 633/72 is_disabled: false - id: 33 value: 0 description: Non imp. Art.8/c D.P.R. 633/72 is_disabled: false - id: 34 value: 0 description: Non Imp. Art.7 ter is_disabled: false - id: 35 value: 0 description: Escluso Art.7 D.P.R 633/72 is_disabled: false - id: 36 value: 22 description: Esigibilita differita Art. 6 comma 5 D.P.R 633/72 is_disabled: false - id: 37 value: 0 description: Escluso Art.10 comma 9 is_disabled: false - id: 38 value: 0 description: Non imp. Art.7 quater DPR 633/72 is_disabled: false - id: 39 value: 0 description: Non Imp. Art.8 comma 1A is_disabled: false - id: 44 value: 0 description: Fuori Campo IVA Art.7 ter D.P.R 633/72 is_disabled: false - id: 45 value: 0 description: Non Imp. Art.10 n.18 DPR 633/72 is_disabled: false - id: 46 value: 0 description: Esente Art.10 DPR 633/72 is_disabled: false - id: 48 value: 0 description: Non imp. art.40 D.L. 427/93 is_disabled: false - id: 49 value: 0 description: Non imp. art.41 D.L. 427/93 is_disabled: false - id: 51 value: 0 description: Non imp. art.8 DPR 633/72 is_disabled: false - id: 52 value: 0 description: Non imp. art.9 DPR 633/72 is_disabled: false - id: 53 value: 0 description: Regime minimi 2015 is_disabled: false - id: 55 value: 0 description: Non soggetta IVA is_disabled: false - id: 56 value: 0 description: R.C. art. 74/7-8 rottami e metalli ferrosi e non is_disabled: false - id: 57 value: 0 description: R.C. art. 17/5 materiale oro e argento is_disabled: false - id: 58 value: 0 description: R.C. art. 17/6/a settore edile subappalto is_disabled: false - id: 59 value: 0 description: R.C. art. 17/6/a-bis fabbricati is_disabled: false - id: 60 value: 0 description: R.C. art. 17/6/b telefoni cellulari is_disabled: false - id: 61 value: 0 description: R.C. art. 17/6/c prodotti elettronici is_disabled: false - id: 62 value: 0 description: >- R.C. art. 17/6/a-ter servizi comparto edile e settori connessi is_disabled: false - id: 63 value: 0 description: >- R.C. art. 17/6/d-bis,d-ter,d-quater gas/energia elettrica is_disabled: false - id: 64 value: 0 description: Non imp. art.71 DPR 633/72 (Vaticano) is_disabled: false - id: 65 value: 0 description: Non imp. art.71 DPR 633/72 (RSM) is_disabled: false - id: 66 value: 0 description: Contribuenti forfettari is_disabled: false ListReceiptsResponse: description: Receipts list. content: application/json: schema: title: ListReceiptsResponse allOf: - title: Pagination type: object description: '' properties: current_page: type: integer description: Current page number. nullable: true first_page_url: type: string format: uri description: First page url. nullable: true from: type: integer nullable: true description: First result of the page. last_page: type: integer description: Last page number. nullable: true last_page_url: type: string format: uri description: Last page url. nullable: true next_page_url: type: string format: uri nullable: true description: Next page url path: type: string format: uri description: Request path. nullable: true per_page: type: integer description: Number of result per page. nullable: true prev_page_url: type: string format: uri nullable: true description: Previous page url. to: type: integer nullable: true description: Last result of the page. total: type: integer description: Total number of results nullable: true - title: ListReceiptsResponsePage type: object properties: data: type: array items: title: Receipt type: object properties: id: type: integer description: Receipt id nullable: true date: type: string description: Receipt date format: date nullable: true number: type: number nullable: true description: Receipt number numeration: type: string description: Receipt numeration nullable: true amount_net: type: number description: Receipt total net amount nullable: true amount_vat: type: number description: Receipt total vat amount nullable: true amount_gross: type: number description: Receipt total gross amount nullable: true use_gross_prices: type: boolean nullable: true description: Receipt uses gross prices type: type: string title: ReceiptType enum: - till_receipt - sales_receipt description: Receipt type description: type: string description: Receipt description nullable: true rc_center: type: string description: Receipt revenue center nullable: true created_at: type: string nullable: true description: Receipt creation date updated_at: type: string nullable: true description: Receipt last update date payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true items_list: type: array nullable: true items: title: ReceiptItemsListItem type: object properties: id: type: integer description: Receipt item id nullable: true amount_net: type: number description: Receipt item total net amount nullable: true amount_gross: type: number description: Receipt item total gross amount nullable: true category: type: string description: Receipt item category nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true nullable: true description: '' examples: example-1: value: current_page: 1 data: - id: 12345 date: '2021-08-20' number: 5 numeration: REC005 amount_net: 16.39 amount_vat: 3.61 amount_gross: 20 use_gross_prices: true type: sales_receipt description: cassa 1 rc_center: '' created_at: '2021-08-20 13:56:56' updated_at: '2021-08-20 13:56:56' payment_account: id: 222 name: carta di credito items_list: - id: 666 amount_net: 10 amount_vat: 2.2 amount_gross: 12.2 category: altro vat: id: 0 value: 22 description: iva - id: 777 amount_net: 100 amount_vat: 4 amount_gross: 104 category: altro vat: id: 0 value: 22 description: iva - id: 12346 date: '2021-08-19' number: 6 numeration: REC006 amount_net: 8.2 amount_vat: 1.8 amount_gross: 10 use_gross_prices: true type: sales_receipt description: cassa 1 rc_center: '' created_at: '2021-08-19 17:57:56' updated_at: '2021-08-19 17:57:56' payment_account: id: 555 name: contanti items_list: - id: 888 amount_net: 8.2 amount_vat: 1.8 amount_gross: 10 category: altro vat: id: 0 value: 22 description: iva first_page_url: page=1 from: 1 last_page: 4 last_page_url: page=4 next_page_url: page=2 path: receipts per_page: 50 prev_page_url: null to: 50 total: 65 CreateReceiptResponse: description: Created Receipt. content: application/json: schema: title: CreateReceiptResponse type: object properties: data: title: Receipt type: object properties: id: type: integer description: Receipt id nullable: true date: type: string description: Receipt date format: date nullable: true number: type: number nullable: true description: Receipt number numeration: type: string description: Receipt numeration nullable: true amount_net: type: number description: Receipt total net amount nullable: true amount_vat: type: number description: Receipt total vat amount nullable: true amount_gross: type: number description: Receipt total gross amount nullable: true use_gross_prices: type: boolean nullable: true description: Receipt uses gross prices type: type: string title: ReceiptType enum: - till_receipt - sales_receipt description: Receipt type description: type: string description: Receipt description nullable: true rc_center: type: string description: Receipt revenue center nullable: true created_at: type: string nullable: true description: Receipt creation date updated_at: type: string nullable: true description: Receipt last update date payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true items_list: type: array nullable: true items: title: ReceiptItemsListItem type: object properties: id: type: integer description: Receipt item id nullable: true amount_net: type: number description: Receipt item total net amount nullable: true amount_gross: type: number description: Receipt item total gross amount nullable: true category: type: string description: Receipt item category nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true nullable: true description: '' examples: example-1: value: data: id: 12346 date: '2021-08-19' number: 6 numeration: REC006 amount_net: 8.2 amount_vat: 1.8 amount_gross: 10 use_gross_prices: true type: sales_receipt description: cassa 1 rc_center: '' created_at: '2021-08-19 17:57:56' updated_at: '2021-08-19 17:57:56' payment_account: id: 555 name: contanti items_list: - id: 888 amount_net: 8.2 amount_vat: 1.8 amount_gross: 10 category: altro vat: id: 0 value: 22 description: iva GetReceiptResponse: description: Receipt Details. content: application/json: schema: title: GetReceiptResponse type: object properties: data: title: Receipt type: object properties: id: type: integer description: Receipt id nullable: true date: type: string description: Receipt date format: date nullable: true number: type: number nullable: true description: Receipt number numeration: type: string description: Receipt numeration nullable: true amount_net: type: number description: Receipt total net amount nullable: true amount_vat: type: number description: Receipt total vat amount nullable: true amount_gross: type: number description: Receipt total gross amount nullable: true use_gross_prices: type: boolean nullable: true description: Receipt uses gross prices type: type: string title: ReceiptType enum: - till_receipt - sales_receipt description: Receipt type description: type: string description: Receipt description nullable: true rc_center: type: string description: Receipt revenue center nullable: true created_at: type: string nullable: true description: Receipt creation date updated_at: type: string nullable: true description: Receipt last update date payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true items_list: type: array nullable: true items: title: ReceiptItemsListItem type: object properties: id: type: integer description: Receipt item id nullable: true amount_net: type: number description: Receipt item total net amount nullable: true amount_gross: type: number description: Receipt item total gross amount nullable: true category: type: string description: Receipt item category nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true nullable: true description: '' examples: example-1: value: data: id: 12346 date: '2021-08-19' number: 6 numeration: REC006 amount_net: 8.2 amount_vat: 1.8 amount_gross: 10 use_gross_prices: true type: sales_receipt description: cassa 1 rc_center: '' created_at: '2021-08-19 17:57:56' updated_at: '2021-08-19 17:57:56' payment_account: id: 555 name: contanti items_list: - id: 888 amount_net: 8.2 amount_vat: 1.8 amount_gross: 10 category: altro vat: id: 0 value: 22 description: iva ModifyReceiptResponse: description: Modified receipt. content: application/json: schema: title: ModifyReceiptResponse type: object properties: data: title: Receipt type: object properties: id: type: integer description: Receipt id nullable: true date: type: string description: Receipt date format: date nullable: true number: type: number nullable: true description: Receipt number numeration: type: string description: Receipt numeration nullable: true amount_net: type: number description: Receipt total net amount nullable: true amount_vat: type: number description: Receipt total vat amount nullable: true amount_gross: type: number description: Receipt total gross amount nullable: true use_gross_prices: type: boolean nullable: true description: Receipt uses gross prices type: type: string title: ReceiptType enum: - till_receipt - sales_receipt description: Receipt type description: type: string description: Receipt description nullable: true rc_center: type: string description: Receipt revenue center nullable: true created_at: type: string nullable: true description: Receipt creation date updated_at: type: string nullable: true description: Receipt last update date payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true items_list: type: array nullable: true items: title: ReceiptItemsListItem type: object properties: id: type: integer description: Receipt item id nullable: true amount_net: type: number description: Receipt item total net amount nullable: true amount_gross: type: number description: Receipt item total gross amount nullable: true category: type: string description: Receipt item category nullable: true vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true nullable: true description: '' examples: example-1: value: data: id: 12346 date: '2021-08-19' number: 6 numeration: REC006 amount_net: 8.2 amount_vat: 1.8 amount_gross: 10 use_gross_prices: true type: sales_receipt description: cassa 1 rc_center: '' created_at: '2021-08-19 17:57:56' updated_at: '2021-08-19 17:57:56' payment_account: id: 555 name: contanti items_list: - id: 888 amount_net: 8.2 amount_vat: 1.8 amount_gross: 10 category: altro vat: id: 0 value: 22 description: iva GetReceiptPreCreateInfoResponse: description: Pre-create info. content: application/json: schema: title: GetReceiptPreCreateInfoResponse type: object properties: data: type: object title: ReceiptPreCreateInfo properties: numerations: title: Numeration type: object additionalProperties: type: object title: NumerationItem additionalProperties: type: integer numerations_list: type: array description: Receipt used numerations list nullable: true items: type: string rc_centers_list: type: array description: Receipt used revenue centers list nullable: true items: type: string payment_accounts_list: type: array description: Payment accounts list nullable: true items: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true categories_list: type: array nullable: true description: Receipt categories list items: type: string vat_types_list: type: array description: Vat types list nullable: true items: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true nullable: true description: '' examples: example-1: value: data: numerations: '2016': sales_receipt: REC003: 12 REC002: 5 REC001: 2 till_receipt: REC002: 6 REC001: 2 '2017': sales_receipt: REC003: 14 REC002: 7 REC001: 1 till_receipt: REC003: 1 REC001: 3 '2018': sales_receipt: REC001: 3 '2019': sales_receipt: REC002: 105 REC001: 22 till_receipt: REC003: 21 REC002: 24 REC001: 25 '2020': sales_receipt: REC001: 3 '2021': sales_receipt: REC005: 3 REC004: 2 REC003: 2 REC001: 7 numerations_list: - REC001 - REC002 - REC003 - REC005 - REC006 rc_centers_list: - Sede generale - Negozio Bergamo - Negozio Milano payment_accounts_list: - id: 111 name: Indesa - carta conto - id: 222 name: Contanti - id: 333 name: Bonifico Bancario categories_list: - altro - arredamento vat_types_list: - id: 1334 value: 0 description: Non imp. art. 17 c. 6 DPR 633/72 e s.m.i. is_disabled: false - id: 1333 value: 0 description: Non sogg. art. 74 c. 7 e 8 DPR 633/72 is_disabled: false - id: 1332 value: 0 description: Non imp. art. 17 c. 6 lett. A TER DPR 633/72 is_disabled: false - id: 1331 value: 22 description: Pippus is_disabled: false - id: 1330 value: 0 description: Natura 4 is_disabled: false - id: 1020 value: 0 description: PA Non imp art. 2 is_disabled: false - id: 1018 value: 0 description: Aliq. 22% reverse charge is_disabled: false - id: 1015 value: 22 description: Speciale prova is_disabled: false - id: 1014 value: 0 description: Ai sensi dellarticolo 123 is_disabled: false - id: 1013 value: 0 description: Non imponibile art. 8 lett. A DPR 633/72 is_disabled: false - id: 1010 value: 0 description: NON IMPONIBILE IVA EX ART. 8 COMMA 1 LETT.A is_disabled: false - id: 1009 value: 20 description: Aliquota 20% is_disabled: false - id: 1008 value: 0 description: Non imp. art. 41 D.L. 427/93 is_disabled: false - id: 1007 value: 0 description: Non imp. art. 71 DPR 633/72 is_disabled: false - id: 1006 value: 0 description: Escl. art. 15 DPR 633/72 is_disabled: false - id: 1004 value: 0 description: Non imp. art. 1 L. 244/2007 is_disabled: false - id: 1003 value: 0 description: Non imp. art. 8 DPR 633/72 is_disabled: false - id: 1002 value: 0 description: Omaggi art. 2 c. 2 n. 4 DPR 633/72 is_disabled: false - id: 1000 value: 0 description: art.26 COMMA' 3 DPR 633/72 is_disabled: false GetReceiptsMonthlyTotalsResponse: description: Monthly Totals. content: application/json: schema: title: GetReceiptsMonthlyTotalsResponse type: object description: '' properties: data: type: array items: type: object title: MonthlyTotal properties: net: type: number description: Monthly total net amount nullable: true gross: type: number description: Monthly total gross amount nullable: true count: type: number description: Monthly total receipt number nullable: true nullable: true examples: example-1: value: data: - net: 15000 gross: 18000 count: 10 - net: 18000 gross: 22000 count: 20 - net: 20000 gross: 24400 count: 30 - net: 19000 gross: 22000 count: 20 - net: 17000 gross: 20000 count: 10 - net: 18000 gross: 24000 count: 21 - net: 22000 gross: 25000 count: 30 - net: 17000 gross: 21000 count: 21 - net: 0 gross: 0 count: 10 - net: 0 gross: 0 count: 20 - net: 0 gross: 0 count: 30 - net: 0 gross: 0 count: 21 ListF24Response: description: Results list. content: application/json: schema: title: ListF24Response description: '' allOf: - title: Pagination type: object description: '' properties: current_page: type: integer description: Current page number. nullable: true first_page_url: type: string format: uri description: First page url. nullable: true from: type: integer nullable: true description: First result of the page. last_page: type: integer description: Last page number. nullable: true last_page_url: type: string format: uri description: Last page url. nullable: true next_page_url: type: string format: uri nullable: true description: Next page url path: type: string format: uri description: Request path. nullable: true per_page: type: integer description: Number of result per page. nullable: true prev_page_url: type: string format: uri nullable: true description: Previous page url. to: type: integer nullable: true description: Last result of the page. total: type: integer description: Total number of results nullable: true - title: ListF24ResponsePage type: object properties: data: type: array items: title: F24 type: object properties: id: type: integer description: F24 id nullable: true due_date: type: string format: date example: '2018-02-12' description: F24 due date nullable: true status: title: F24Status type: string enum: - paid - not_paid - reversed description: F24 status payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true amount: type: number description: F24 amount example: 300 nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] F24 url of the attached file nullable: true readOnly: true attachment_token: type: string nullable: true description: >- [Write Only] F24 attachment token returned by POST /taxes/attachment writeOnly: true description: type: string description: F24 description nullable: true nullable: true - title: ListF24ResponseAggregatedData type: object properties: aggregated_data: title: ListF24ResponseAggregatedData type: object properties: amount: type: number description: Total amount. nullable: true nullable: true examples: example-1: value: current_page: 1 data: - id: 12345 amount: 840.36 description: PAGAMENTO IVA 2021 due_date: '2021-12-31' status: paid payment_account: id: 111 name: Indesa - carta conto attachment_url: b19c01da9b1688fb73d0d9e8adae89a8.pdf - id: 12346 amount: 810.62 description: PAGAMENTO IVA 2020 due_date: '2020-12-31' status: paid payment_account: id: 111 name: Indesa - carta conto attachment_url: bb6df8490dad4770353b378ea926d8ba.pdf first_page_url: page=1 from: 1 last_page: 1 last_page_url: page=1 next_page_url: null path: taxes per_page: 50 prev_page_url: null to: 2 total: 2 aggregated_data: amount: '6438.96' CreateF24Response: description: The created F24 content: application/json: schema: title: CreateF24Response type: object properties: data: title: F24 type: object properties: id: type: integer description: F24 id nullable: true due_date: type: string format: date example: '2018-02-12' description: F24 due date nullable: true status: title: F24Status type: string enum: - paid - not_paid - reversed description: F24 status payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true amount: type: number description: F24 amount example: 300 nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] F24 url of the attached file nullable: true readOnly: true attachment_token: type: string nullable: true description: |- [Write Only] F24 attachment token returned by POST /taxes/attachment writeOnly: true description: type: string description: F24 description nullable: true nullable: true description: '' examples: example-1: value: data: id: 12345 amount: 840.36 description: PAGAMENTO IVA 2021 due_date: '2021-12-31' status: paid payment_account: id: 111 name: Indesa - carta conto attachment_url: b19c01da9b1688fb73d0d9e8adae89a8.pdf GetF24Response: description: The F24 content: application/json: schema: title: GetF24Response type: object properties: data: title: F24 type: object properties: id: type: integer description: F24 id nullable: true due_date: type: string format: date example: '2018-02-12' description: F24 due date nullable: true status: title: F24Status type: string enum: - paid - not_paid - reversed description: F24 status payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true amount: type: number description: F24 amount example: 300 nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] F24 url of the attached file nullable: true readOnly: true attachment_token: type: string nullable: true description: |- [Write Only] F24 attachment token returned by POST /taxes/attachment writeOnly: true description: type: string description: F24 description nullable: true nullable: true examples: example-1: value: data: id: 12345 amount: 840.36 description: PAGAMENTO IVA 2021 due_date: '2021-12-31' status: paid payment_account: id: 111 name: Indesa - carta conto attachment_url: b19c01da9b1688fb73d0d9e8adae89a8.pdf ModifyF24Response: description: The modified F24 content: application/json: schema: title: ModifyF24Response type: object properties: data: title: F24 type: object properties: id: type: integer description: F24 id nullable: true due_date: type: string format: date example: '2018-02-12' description: F24 due date nullable: true status: title: F24Status type: string enum: - paid - not_paid - reversed description: F24 status payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true amount: type: number description: F24 amount example: 300 nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] F24 url of the attached file nullable: true readOnly: true attachment_token: type: string nullable: true description: |- [Write Only] F24 attachment token returned by POST /taxes/attachment writeOnly: true description: type: string description: F24 description nullable: true nullable: true description: '' examples: example-1: value: data: id: 12345 amount: 840.36 description: PAGAMENTO IVA 2021 due_date: '2021-12-31' status: paid payment_account: id: 111 name: Indesa - carta conto attachment_url: b19c01da9b1688fb73d0d9e8adae89a8.pdf UploadF24AttachmentResponse: description: Attachment Token. content: application/json: schema: title: UploadF24AttachmentResponse type: object properties: data: title: AttachmentData type: object properties: attachment_token: type: string example: YmMyNWYxYzIwMTU3N2Y4ZGE3ZjZiMzg5OWY0ODNkZDQveXl5LmRvYw description: Uploaded attachment token. nullable: true nullable: true examples: example-1: value: data: attachment_token: YmMyNWYxYzIwMTU3N2Y4ZGE3ZjZiMzg5OWY0ODNkZDQveXl5LmRvYw ListArchiveDocumentsResponse: description: Results list. content: application/json: schema: title: ListArchiveDocumentsResponse allOf: - title: Pagination type: object description: '' properties: current_page: type: integer description: Current page number. nullable: true first_page_url: type: string format: uri description: First page url. nullable: true from: type: integer nullable: true description: First result of the page. last_page: type: integer description: Last page number. nullable: true last_page_url: type: string format: uri description: Last page url. nullable: true next_page_url: type: string format: uri nullable: true description: Next page url path: type: string format: uri description: Request path. nullable: true per_page: type: integer description: Number of result per page. nullable: true prev_page_url: type: string format: uri nullable: true description: Previous page url. to: type: integer nullable: true description: Last result of the page. total: type: integer description: Total number of results nullable: true - title: ListArchiveDocumentsResponsePage type: object properties: data: type: array items: title: ArchiveDocument type: object properties: id: type: integer description: Archive document id nullable: true date: type: string format: date description: Archive document date nullable: true description: type: string description: Archive Document description nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Archive Document url of the attached file nullable: true readOnly: true category: type: string description: Archive document category nullable: true attachment_token: type: string description: >- [Write Only] [Required] Archive document attachment token returned by POST /archive/attachment nullable: true writeOnly: true nullable: true description: '' examples: example-1: value: current_page: 1 data: - id: 12345 date: '2021-08-20' category: Altri documenti description: spesa 2 attachment_url: spesa2.pdf - id: 12346 date: '2021-08-19' category: Altri documenti description: spesa 1 attachment_url: spesa1.pdf first_page_url: page=1 from: 1 last_page: 1 last_page_url: page=1 next_page_url: null path: /archive per_page: 50 prev_page_url: null to: 2 total: 2 CreateArchiveDocumentResponse: description: The Archive Document. content: application/json: schema: title: CreateArchiveDocumentResponse type: object properties: data: title: ArchiveDocument type: object properties: id: type: integer description: Archive document id nullable: true date: type: string format: date description: Archive document date nullable: true description: type: string description: Archive Document description nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Archive Document url of the attached file nullable: true readOnly: true category: type: string description: Archive document category nullable: true attachment_token: type: string description: >- [Write Only] [Required] Archive document attachment token returned by POST /archive/attachment nullable: true writeOnly: true nullable: true description: '' examples: example-1: value: data: id: 12345 date: '2021-08-20' category: Altri documenti description: spesa 1 attachment_url: spesa1.pdf GetArchiveDocumentResponse: description: Archive Document Details content: application/json: schema: title: GetArchiveDocumentResponse type: object properties: data: title: ArchiveDocument type: object properties: id: type: integer description: Archive document id nullable: true date: type: string format: date description: Archive document date nullable: true description: type: string description: Archive Document description nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Archive Document url of the attached file nullable: true readOnly: true category: type: string description: Archive document category nullable: true attachment_token: type: string description: >- [Write Only] [Required] Archive document attachment token returned by POST /archive/attachment nullable: true writeOnly: true nullable: true description: '' examples: example-1: value: data: id: 12345 date: '2021-08-20' category: Altri documenti description: spesa 2 attachment_url: spesa2.pdf ModifyArchiveDocumentResponse: description: The modified Archived Document content: application/json: schema: title: ModifyArchiveDocumentResponse type: object description: '' properties: data: title: ArchiveDocument type: object properties: id: type: integer description: Archive document id nullable: true date: type: string format: date description: Archive document date nullable: true description: type: string description: Archive Document description nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Archive Document url of the attached file nullable: true readOnly: true category: type: string description: Archive document category nullable: true attachment_token: type: string description: >- [Write Only] [Required] Archive document attachment token returned by POST /archive/attachment nullable: true writeOnly: true nullable: true examples: example-1: value: data: id: 12345 date: '2021-08-20' category: Altri documenti description: spesa 2 attachment_url: spesa2.pdf ListCashbookEntriesResponse: description: Results list. content: application/json: schema: title: ListCashbookEntriesResponse type: object properties: data: type: array items: title: CashbookEntry type: object properties: id: type: string description: Cashbook id nullable: true date: description: Cashbook date format: date type: string nullable: true description: type: string description: Cashbook description nullable: true kind: title: CashbookEntryKind type: string enum: - cashbook - issued_document - received_document - tax - receipt description: Cashbook kind type: title: CashbookEntryType type: string nullable: true enum: - in - out description: Cashbook type entity_name: type: string description: Cashbook entity name nullable: true document: type: object nullable: true properties: id: type: integer description: Cashbook related document id nullable: true type: type: string description: Cashbook related document type nullable: true path: type: string description: Cashbook related document path nullable: true amount_in: type: number description: |- [Only for cashbook entry in] Cashbook total amount in nullable: true payment_account_in: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true description: |- [Only for cashbook entry in] Cashbook payment account in amount_out: type: number description: |- [Only for cashbook entry out] Cashbook total amount out nullable: true payment_account_out: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true description: |- [Only for cashbook entry out] Cashbook payment account out nullable: true description: '' examples: example-1: value: data: - date: '2021-08-24' amount_in: 122 payment_account_in: id: 333 description: Fattura n. 201/2021 entity_name: Rossi S.r.l. kind: issued_document document: id: 54321 type: in - date: '2021-08-29' amount_out: 211 payment_account_out: id: 444 description: Fattura n. 202/2021 entity_name: Red S.r.l. kind: issued_document document: id: 12345 type: out CreateCashbookEntryResponse: description: The created Cashbook Entry. content: application/json: schema: title: CreateCashbookEntryResponse description: '' type: object properties: data: title: CashbookEntry type: object properties: id: type: string description: Cashbook id nullable: true date: description: Cashbook date format: date type: string nullable: true description: type: string description: Cashbook description nullable: true kind: title: CashbookEntryKind type: string enum: - cashbook - issued_document - received_document - tax - receipt description: Cashbook kind type: title: CashbookEntryType type: string nullable: true enum: - in - out description: Cashbook type entity_name: type: string description: Cashbook entity name nullable: true document: type: object nullable: true properties: id: type: integer description: Cashbook related document id nullable: true type: type: string description: Cashbook related document type nullable: true path: type: string description: Cashbook related document path nullable: true amount_in: type: number description: |- [Only for cashbook entry in] Cashbook total amount in nullable: true payment_account_in: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true description: |- [Only for cashbook entry in] Cashbook payment account in amount_out: type: number description: |- [Only for cashbook entry out] Cashbook total amount out nullable: true payment_account_out: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true description: |- [Only for cashbook entry out] Cashbook payment account out nullable: true examples: example-1: value: data: id: 54321 date: '2021-08-24' amount_in: 122 amount_out: 0 description: Fattura n. 201/2021 payment_account_in: id: 21 name: Indesa - Carta conto payment_account_out: null kind: cashbook GetCashbookEntryResponse: description: Cashbook Entry. content: application/json: schema: title: GetCashbookEntryResponse type: object description: '' properties: data: title: CashbookEntry type: object properties: id: type: string description: Cashbook id nullable: true date: description: Cashbook date format: date type: string nullable: true description: type: string description: Cashbook description nullable: true kind: title: CashbookEntryKind type: string enum: - cashbook - issued_document - received_document - tax - receipt description: Cashbook kind type: title: CashbookEntryType type: string nullable: true enum: - in - out description: Cashbook type entity_name: type: string description: Cashbook entity name nullable: true document: type: object nullable: true properties: id: type: integer description: Cashbook related document id nullable: true type: type: string description: Cashbook related document type nullable: true path: type: string description: Cashbook related document path nullable: true amount_in: type: number description: |- [Only for cashbook entry in] Cashbook total amount in nullable: true payment_account_in: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true description: |- [Only for cashbook entry in] Cashbook payment account in amount_out: type: number description: |- [Only for cashbook entry out] Cashbook total amount out nullable: true payment_account_out: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true description: |- [Only for cashbook entry out] Cashbook payment account out nullable: true examples: example-1: value: data: date: '2021-08-24' amount_in: 122 payment_account_in: id: 333 description: Fattura n. 201/2021 entity_name: Rossi S.r.l. kind: issued_document document: id: 54321 type: in ModifyCashbookEntryResponse: description: The modified Cashbook Entry content: application/json: schema: title: ModifyCashbookEntryResponse type: object properties: data: title: CashbookEntry type: object properties: id: type: string description: Cashbook id nullable: true date: description: Cashbook date format: date type: string nullable: true description: type: string description: Cashbook description nullable: true kind: title: CashbookEntryKind type: string enum: - cashbook - issued_document - received_document - tax - receipt description: Cashbook kind type: title: CashbookEntryType type: string nullable: true enum: - in - out description: Cashbook type entity_name: type: string description: Cashbook entity name nullable: true document: type: object nullable: true properties: id: type: integer description: Cashbook related document id nullable: true type: type: string description: Cashbook related document type nullable: true path: type: string description: Cashbook related document path nullable: true amount_in: type: number description: |- [Only for cashbook entry in] Cashbook total amount in nullable: true payment_account_in: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true description: |- [Only for cashbook entry in] Cashbook payment account in amount_out: type: number description: |- [Only for cashbook entry out] Cashbook total amount out nullable: true payment_account_out: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true description: |- [Only for cashbook entry out] Cashbook payment account out nullable: true description: '' examples: example-1: value: data: date: '2021-08-24' amount_in: 122 payment_account_in: id: 333 description: Fattura n. 201/2021 entity_name: Rossi S.r.l. kind: issued_document document: id: 54321 type: in ListCountriesResponse: description: List of countries content: application/json: schema: title: ListCountriesResponse type: object properties: data: type: array items: type: string nullable: true description: '' examples: example-1: value: data: - Italia - Afghanistan - Albania - Algeria - Andorra - Angola - Anguilla - ... ListCitiesResponse: description: Cities List. content: application/json: schema: title: ListCitiesResponse type: object description: '' properties: data: type: array items: title: City type: object properties: postal_code: type: string description: City postal code nullable: true city: type: string description: City name nullable: true province: type: string description: City province nullable: true nullable: true examples: example-1: value: data: - postal_code: '89867' city: Zungri province: VV - postal_code: '83020' city: Aiello del Sabato province: AV - postal_code: '83011' city: Altavilla Irpina province: AV ListLanguagesResponse: description: LanguagesList content: application/json: schema: title: ListLanguagesResponse type: object description: '' properties: data: type: array items: type: object title: Language properties: code: type: string description: Language code nullable: true name: type: string description: Language extended name nullable: true nullable: true examples: example-1: value: data: - code: it name: Italiano - code: en name: Inglese ListTemplatesResponse: description: Templates list. content: application/json: schema: title: ListTemplatesResponse type: object properties: data: type: array items: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true nullable: true description: '' examples: example-1: value: data: - id: 10 name: New Standard S1 - id: 106 name: Minimalist ListCurrenciesResponse: description: Currencies List. content: application/json: schema: title: ListCurrenciesResponse type: object description: '' properties: data: type: array items: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true nullable: true examples: example-1: value: data: - id: AED symbol: AED html_symbol: AED exchange_rate: '4.09500' - id: EUR symbol: € html_symbol: '€' exchange_rate: '1.00000' ListUnitsOfMeasureResponse: description: Units of measure. content: application/json: schema: title: ListUnitsOfMeasureResponse type: object properties: data: type: array items: type: string nullable: true description: '' examples: example-1: value: data: - pezzi - kg - litri - ore - giorni - km - mesi ListDeliveryNotesDefaultCausalsResponse: description: List of Delivery Notes Default Causals content: application/json: schema: title: ListDeliveryNotesDefaultCasualsResponse type: object description: '' properties: data: type: array items: type: string nullable: true examples: example-1: value: data: - Vendita - Conto visione - Conto deposito - Conto vendita - Tentata vendita - Prestito d'uso - Conto lavorazione - Omaggio - Riparazione - Reso per accredito - Reso per sostituzione ListVatTypesResponse: description: List of Vat Types. content: application/json: schema: title: ListVatTypesResponse type: object properties: data: type: array items: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true nullable: true description: '' examples: example-1: value: data: - id: 0 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: string ei_type: 2 ei_description: string editable: true - id: 1010 value: 0 description: NON IMPONIBILE IVA EX ART. 8 COMMA 1 LETT.A notes: '' e_invoice: false ei_type: 0 ei_description: null is_disabled: false editable: true ListPaymentMethodsResponse: description: Payment methods list. content: application/json: schema: title: ListPaymentMethodsResponse type: object description: '' properties: data: type: array items: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true nullable: true examples: example-1: value: data: - id: 12345 name: Carta di credito is_default: false default_payment_account: null - id: 12346 name: Bonifico bancario is_default: true default_payment_account: null ListPaymentAccountsResponse: description: Payment accounts list. content: application/json: schema: title: ListPaymentAccountsResponse type: object properties: data: type: array items: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true nullable: true description: '' examples: example-1: value: data: - id: 21 name: Indesa - Carta conto type: standard iban: null sia: null virtual: false - id: 109 name: Indesa type: bank iban: IT17A1234563200000003498936 sia: IN234 virtual: false ListRevenueCentersResponse: description: List of Revenue Centers content: application/json: schema: title: ListRevenueCentersResponse type: object description: '' properties: data: type: array items: type: string nullable: true examples: example-1: value: data: - Negozio Bergamo - Negozio Milano ListCostCentersResponse: description: List of Cost Centers content: application/json: schema: title: ListCostCentersResponse type: object properties: data: type: array items: type: string nullable: true examples: example-1: value: data: - Negozio Bergamo - Negozio Milano ListProductCategoriesResponse: description: Product Categories List content: application/json: schema: title: ListProductCategoriesResponse type: object properties: data: type: array items: type: string nullable: true description: '' examples: example-1: value: data: - Alimentari - Arredamento ListReceivedDocumentCategoriesResponse: description: Received Document Categories List content: application/json: schema: title: ListReceivedDocumentCategoriesResponse type: object description: '' properties: data: type: array items: type: string nullable: true examples: example-1: value: data: - Telefono e internet - Assicurazioni e quote - Auto ed altri veicoli - Computer e accessori - Server e hosting ListArchiveCategoriesResponse: description: Archive Categories list. content: application/json: schema: title: ListArchiveCategoriesResponse type: object properties: data: type: array items: type: string nullable: true examples: example-1: value: data: - Altri documenti - Conferme d'ordine - Contratti - Dichiarazioni dei redditi - Documenti per detrazioni - Estratti conto bancari - Estratti conto carte di credito UploadArchiveAttachmentResponse: description: Example response content: application/json: schema: title: UploadArchiveAttachmentResponse type: object properties: data: title: AttachmentData type: object properties: attachment_token: type: string example: YmMyNWYxYzIwMTU3N2Y4ZGE3ZjZiMzg5OWY0ODNkZDQveXl5LmRvYw description: Uploaded attachment token. nullable: true nullable: true examples: example-1: value: data: attachment_token: YmMyNWYxYzIwMTU3N212ABCDZjZiMzg5OWY0ODNkZDQveXl5LmRvYw CreatePaymentMethodResponse: description: Example response content: application/json: schema: title: CreatePaymentMethodResponse type: object properties: data: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true nullable: true examples: example-1: value: data: id: 386683 name: Bonifico bancario is_default: true type: standard details: - title: Banca description: Sao Paulo default_payment_account: id: 12345 name: conto banca SP GetPaymentMethodResponse: description: Example response content: application/json: schema: title: GetPaymentMethodResponse type: object properties: data: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true nullable: true examples: example-1: value: data: id: 386683 name: Bonifico bancario is_default: true type: standard details: - title: Banca description: Sao Paulo default_payment_account: id: 12345 name: conto banca SP ModifyPaymentMethodResponse: description: Example response content: application/json: schema: title: ModifyPaymentMethodResponse type: object properties: data: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true nullable: true examples: example-1: value: data: id: 386683 name: Bonifico bancario is_default: true type: standard details: - title: Banca description: Sao Paulo default_payment_account: id: 12345 name: conto banca SP CreatePaymentAccountResponse: description: Example response content: application/json: schema: title: CreatePaymentAccountResponse type: object properties: data: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true examples: example-1: value: data: id: 12345 name: Indesa type: bank iban: IT17Q0051343200000003497636 sia: T1234 virtual: false GetPaymentAccountResponse: description: Example response content: application/json: schema: title: GetPaymentAccountResponse type: object properties: data: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true examples: example-1: value: data: id: 12345 name: Indesa type: bank iban: IT17Q0051343200000003497636 sia: T1234 virtual: false ModifyPaymentAccountResponse: description: Example response content: application/json: schema: title: ModifyPaymentAccountResponse type: object properties: data: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true examples: example-1: value: data: id: 12345 name: Indesa type: bank iban: IT17Q0051343200000003497636 sia: T1234 virtual: false CreateVatTypeResponse: description: Example response content: application/json: schema: title: CreateVatTypeResponse type: object properties: data: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true examples: example-1: value: data: id: 0 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: true ei_type: 2 ei_description: string editable: true is_disabled: true GetVatTypeResponse: description: Example response content: application/json: schema: title: GetVatType type: object properties: data: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true examples: example-1: value: data: id: 0 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: true ei_type: 2 ei_description: string editable: true is_disabled: true ModifyVatTypeResponse: description: Example response content: application/json: schema: title: ModifyVatTypeResponse type: object properties: data: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true examples: example-1: value: data: id: 0 value: 22 description: Non imponibile art. 123 notes: IVA non imponibile ai sensi dell'articolo 123, comma 2 e_invoice: true ei_type: 2 ei_description: string editable: true is_disabled: true GetEInvoiceXmlResponse: description: '' content: text/xml: schema: title: GetEInvoiceXmlResponse type: string description: XML of the e-invoice GetEInvoiceRejectionReasonResponse: description: Example response content: application/json: schema: title: GetEInvoiceRejectionReason type: object properties: data: title: EInvoiceRejectionReason type: object properties: reason: type: string description: E-invoice rejection reason nullable: true ei_status: type: string description: E-invoice status nullable: true solution: type: string description: Error solution. nullable: true code: type: string description: E-invoice rejection error code nullable: true date: type: string format: date-time description: E-invoice rejection date nullable: true nullable: true examples: example-1: value: data: reason: >- La Partita IVA della tua azienda risulta sbagliata e/o cessata. ei_status: rejected solution: >- Puoi correggere la tua Partita IVA in: Impostazioni > Azienda > Informazioni di fatturazione. date: '2023-06-06' ListDetailedCountriesResponse: description: List of detailed countries content: application/json: schema: title: ListDetailedCountriesResponse type: object properties: data: type: array items: title: DetailedCountry type: object properties: name: type: string nullable: true description: Country name settings_name: type: string nullable: true description: Country settings name iso: type: string nullable: true description: Country iso code fiscal_iso: type: string nullable: true description: Country fiscal iso code uic: type: string nullable: true description: Country uic examples: example-1: value: data: - name: Italia settings_name: Italia iso: IT fiscal_iso: IT uic: '086' - name: Afghanistan settings_name: Afghanistan iso: AF fiscal_iso: AF uic: '002' - name: Albania settings_name: Albania iso: AL fiscal_iso: AL uic: '087' TransformIssuedDocumentResponse: description: Example response content: application/json: schema: title: TransformIssuedDocumentResponse type: object properties: data: title: IssuedDocument type: object properties: id: type: integer description: Issued document id nullable: true entity: title: Entity type: object properties: id: type: integer nullable: true description: Entity id code: type: string example: '123' description: Entity code nullable: true name: type: string example: Rossi S.r.l. description: Entity name nullable: true type: title: EntityType type: string nullable: true default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name nullable: true last_name: type: string description: Entity last name nullable: true contact_person: type: string nullable: true description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Entitity address street nullable: true address_postal_code: type: string example: '24010' nullable: true description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city nullable: true address_province: type: string example: BG description: Entity address province nullable: true address_extra: type: string description: Entity address extra info nullable: true country: type: string example: Italia description: Entity country nullable: true country_iso: type: string example: Italia description: Entity country iso code nullable: true email: type: string example: mario.rossi@example.it description: Entity email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email nullable: true phone: type: string nullable: true description: Entity phone fax: type: string nullable: true description: Entity fax notes: type: string description: Entity extra nullable: true default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name nullable: true bank_iban: type: string description: |- [Only for client] Client bank iban nullable: true bank_swift_code: type: string description: |- [Only for client] Client bank swift code nullable: true shipping_address: type: string description: |- [Only for client] Client Shipping address nullable: true e_invoice: type: boolean description: |- [Only for client] Use e-invoices. nullable: true ei_code: type: string description: |- [Only for client] E-invoices code. nullable: true has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. nullable: true intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Entity creation date updated_at: type: string nullable: true description: Entity last update date type: type: string default: invoice enum: - invoice - quote - proforma - receipt - delivery_note - credit_note - order - work_report - supplier_order - self_own_invoice - self_supplier_invoice description: Issued document type number: type: integer description: |- Issued document number [If not specified, next number is used] example: 1 nullable: true numeration: type: string description: |- Issued document numeration [Not available if type=delivery_note] example: /A nullable: true date: type: string description: |- Issued document date [defaults to today's date] format: date nullable: true year: type: integer description: Issued document year nullable: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true language: type: object title: Language properties: code: type: string description: Language code nullable: true name: type: string description: Language extended name nullable: true subject: type: string description: Issued document subject nullable: true visible_subject: type: string description: Issued document visible subject nullable: true rc_center: type: string description: >- Issued document revenue center [or cost center if type=supplier_order]. nullable: true notes: type: string description: Issued document extra notes nullable: true rivalsa: type: number description: Issued document "Rivalsa INPS" percentual value nullable: true cassa: type: number description: Issued document "Cassa previdenziale" percentual value nullable: true amount_cassa: type: number description: |- [Read Only] Issued document cassa amount. nullable: true readOnly: true cassa_taxable: type: number description: Issued document cassa taxable percentage nullable: true amount_cassa_taxable: type: number nullable: true description: |- [Can be set only if cassa_taxable is NULL] Issued document cassa taxable amount cassa2: type: number description: Issued document "Cassa previdenziale 2" percentual value nullable: true amount_cassa2: type: number nullable: true description: |- [Read Only] Issued document cassa2 amount readOnly: true cassa2_taxable: type: number description: Issued document cassa2 taxable percentage nullable: true amount_cassa2_taxable: type: number nullable: true description: |- [Can be set only if cassa2_taxable is NULL] Issued document cassa2 taxable amount global_cassa_taxable: type: number description: Issued document global cassa taxable percentage nullable: true amount_global_cassa_taxable: type: number nullable: true description: |- [Can be set only if global_cassa_taxable is NULL] Issued document global cassa taxable amount withholding_tax: type: number description: >- Issued document withholding tax (ritenuta d'acconto) percentual value nullable: true withholding_tax_taxable: type: number description: >- Issued document withholding tax taxable (imponibile) percentual value nullable: true other_withholding_tax: type: number description: >- Issued document other withholding tax (altra ritenuta) percentual value nullable: true stamp_duty: type: number description: |- Issued document stamp duty value [0 if not present] nullable: true payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true use_split_payment: type: boolean description: Issued document uses split payment nullable: true use_gross_prices: type: boolean description: Issued document uses gross prices nullable: true e_invoice: type: boolean description: Issued document is an e-invoice. nullable: true ei_data: type: object nullable: true description: |- Issued document e-invoice data [Only if e_invoice=true] properties: vat_kind: title: VatKind type: string nullable: true description: Vat kind [esigibilità IVA] default: null enum: - null - I - D - S original_document_type: title: OriginalDocumentType type: string nullable: true description: Issued document original document type default: null enum: - ordine - contratto - convenzione od_number: type: string nullable: true description: E-invoice original document number od_date: type: string description: E-invoice original document date format: date nullable: true cig: type: string nullable: true description: E-invoice CIG cup: type: string nullable: true description: E-invoice CUP payment_method: type: string nullable: true description: >- E-invoice payment method [required for e-invoices] (see [here](https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.2/Rappresentazione_Tabellare_FattOrdinaria_V1.2.2.pdf) for the accepted values of ModalitaPagamento) bank_name: type: string nullable: true description: E-invoice bank name bank_iban: type: string nullable: true description: E-invoice bank IBAN bank_beneficiary: type: string nullable: true description: E-invoice bank beneficiary invoice_number: type: string description: E-invoice invoice number nullable: true invoice_date: type: string format: date description: E-invoice invoice date nullable: true ei_cassa_type: type: string nullable: true description: E-invoice cassa type ei_cassa2_type: type: string nullable: true description: E-invoice cassa2 type ei_withholding_tax_causal: type: string nullable: true description: E-invoice withholding tax causal ei_other_withholding_tax_type: type: string nullable: true description: E-invoice other withholding tax type ei_other_withholding_tax_causal: type: string nullable: true description: E-invoice other withholding tax causal items_list: type: array nullable: true items: title: IssuedDocumentItemsListItem type: object properties: id: type: integer description: Issued document item id nullable: true product_id: type: integer nullable: true description: Issued document item product id example: 1234 code: type: string description: Issued document item product code example: '239874892374982' nullable: true name: type: string description: Issued document item product name example: Water bottle nullable: true category: type: string description: Issued document item product category nullable: true description: type: string description: Issued document product description nullable: true qty: type: number description: Issued document item quantity nullable: true measure: type: string description: Issued document item measure nullable: true net_price: type: number description: Issued document item net price example: 1.23 nullable: true gross_price: type: number nullable: true example: 1.45 description: Issued document item gross price vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true not_taxable: type: boolean nullable: true description: Issued document item is not taxable apply_withholding_taxes: type: boolean description: >- Issued document item apply withholding taxes, rivalsa and cassa nullable: true discount: type: number description: Issued document item discount percentual value nullable: true discount_highlight: type: boolean nullable: true description: Issued document item highlight discount in_dn: type: boolean nullable: true description: Issued document item add in delivery note stock: type: boolean nullable: true description: Issued document item move stock ei_raw: type: object description: >- Issued document advanced raw attributes for e-invoices nullable: true payments_list: type: array nullable: true items: title: IssuedDocumentPaymentsListItem type: object properties: id: type: integer description: Issued document payment item id nullable: true due_date: type: string description: Issued document payment due date format: date example: '2018-04-03' nullable: true amount: type: number description: Issued document payment amount example: 1.45 nullable: true status: title: IssuedDocumentStatus type: string description: Issued document status default: not_paid enum: - not_paid - paid - reversed payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true paid_date: type: string description: |- Issued document payment date [Only if status is paid] format: date example: '2018-04-03' nullable: true ei_raw: type: object nullable: true description: >- Issued document payment advanced raw attributes for e-invoices payment_terms: type: object properties: days: type: integer nullable: true description: >- Issued document payment number of days by which the payment must be made type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true delivery_note_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true acc_inv_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true h_margins: type: integer description: Issued document PDF horizontal margins nullable: true v_margins: type: integer description: Issued document PDF vertical margins nullable: true show_payments: type: boolean description: Show the expiration dates of the payments on the document nullable: true show_payment_method: type: boolean description: Show the payment method details on the document nullable: true show_totals: title: ShowTotalsMode type: string description: Show totals mode default: all enum: - none - nets - all show_notification_button: type: boolean description: Show notification button in the PDF nullable: true show_tspay_button: type: boolean description: Show ts pay button in the PDF nullable: true delivery_note: type: boolean nullable: true description: Issued document has delivery note accompanying_invoice: type: boolean description: Issued document has an accompanying invoice nullable: true dn_number: type: integer description: Issued document attached delivery note number nullable: true dn_date: type: string description: Issued document attached delivery note date format: date nullable: true dn_ai_packages_number: type: string nullable: true description: Issued document attached delivery note number of packages dn_ai_weight: type: string nullable: true description: Issued document attached delivery note package weight dn_ai_causal: type: string nullable: true description: Issued document attached delivery note causal dn_ai_destination: type: string nullable: true description: Issued document attached delivery note destination dn_ai_transporter: type: string nullable: true description: Issued document attached delivery note transporter dn_ai_notes: type: string nullable: true description: Issued document attached delivery note notes is_marked: type: boolean description: Issued document is marked nullable: true amount_net: type: number description: |- [Read only] Issued document total net amount nullable: true readOnly: true amount_vat: type: number description: |- [Read Only] Issued document total vat amount nullable: true readOnly: true amount_gross: type: number description: |- [Read Only] Issued document total gross amount nullable: true readOnly: true amount_due_discount: type: number description: Issued document amount due discount nullable: true amount_rivalsa: type: number description: |- [Read Only] Issued document rivalsa amount nullable: true readOnly: true amount_rivalsa_taxable: type: number nullable: true description: Issued document taxable rivalsa amount amount_withholding_tax: type: number description: >- [Read Only] Issued document withholding tax amount (ritenuta d'acconto). nullable: true readOnly: true amount_withholding_tax_taxable: type: number nullable: true description: Issued document taxable withholding tax amount amount_other_withholding_tax: type: number description: >- [Read Only] Issued document other withholding tax amount (altra ritenuta) nullable: true readOnly: true amount_other_withholding_tax_taxable: type: number nullable: true description: Issued document taxable other withholding tax amount amount_enasarco_taxable: type: number nullable: true description: Issued document taxable enasarco amount extra_data: type: object nullable: true description: >- Issued document extra data [TS fields follow the technical specifications provided by "Sistema Tessera Sanitaria"] properties: multifatture_sent: type: integer nullable: true ts_communication: type: boolean nullable: true description: Send issued document to "Sistema Tessera Sanitaria" ts_flag_tipo_spesa: type: number nullable: true description: >- Issued document ts "tipo spesa" [TK, FC, FV, SV,SP, AD, AS, ECG, SR] ts_pagamento_tracciato: type: boolean nullable: true description: Issued document ts traced payment ts_tipo_spesa: type: string description: >- Can be [ 'TK', 'FC', 'FV', 'SV', 'SP', 'AD', 'AS', 'SR', 'CT', 'PI', 'IC', 'AA' ]. Refer to the technical specifications to learn more. nullable: true ts_opposizione: type: boolean nullable: true description: Issued document ts "opposizione" ts_status: type: integer nullable: true description: Issued document ts status ts_file_id: type: string nullable: true description: Issued document ts file id ts_sent_date: type: string nullable: true format: date description: Issued document ts sent date ts_full_amount: type: boolean nullable: true description: Issued document ts total amount imported_by: type: string nullable: true description: Issued document imported by software seen_date: type: string nullable: true description: Issued document seen date format: date next_due_date: type: string nullable: true description: Issued document date of the next not paid payment format: date url: type: string description: |- [Temporary] [Read Only] Issued document url of the document PDF file nullable: true dn_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached delivery note PDF file nullable: true ai_url: type: string description: |- [Temporary] [Read Only] Issued document url of the accompanying invoice PDF file nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached file nullable: true readOnly: true attachment_token: type: string nullable: true description: >- [Write Only] Issued document attachment token returned by POST /issued_documents/attachment writeOnly: true ei_raw: type: object nullable: true description: Issued document advanced raw attributes for e-invoices ei_status: type: string description: | [Read only] Status of the e-invoice. * **attempt** - We are trying to send the invoice, please wait up to 2 hours * **missing** - The invoice is missing * **not_sent** - The invoice has yet to be sent * **sent** - The invoice was sent * **pending** - The checks for the digital signature and sending are in progress * **processing** - The SDI is delivering the invoice to the customer * **error** - An error occurred while handling the invoice, please try to resend it or contact support * **discarded** - The invoice has been rejected by the SDI, so it must be corrected and re-sent * **not_delivered** - The SDI was unable to deliver the invoice * **accepted** - The customer accepted the invoice * **rejected** - The customer rejected the invoice, so it must be corrected * **no_response** - A response has not yet been received whithin the deadline, contact the customer to ascertain the status of the invoice * **manual_accepted** - The customer accepted the invoice * **manual_rejected** - The customer rejected the invoice enum: - attempt - missing - not_sent - sent - pending - processing - error - discarded - not_delivered - accepted - rejected - no_response - manual_accepted - manual_rejected nullable: true locked: type: boolean nullable: true description: Issued Document can't be edited created_at: type: string nullable: true description: Issued document creation date updated_at: type: string nullable: true description: Issued document last update date nullable: true options: title: IssuedDocumentOptions type: object properties: fix_payments: type: boolean description: >- Fixes your last payment amount to match your document total nullable: true create_from: type: array description: Original documents ids [only for join/transform] nullable: true items: type: string transform: type: boolean description: Tranform a document [only for transform] nullable: true keep_copy: type: boolean description: Keep original document [only for transform] nullable: true join_type: type: string description: Join type [only for join] nullable: true nullable: true examples: example-1: value: data: type: invoice year: 2022 numeration: '' subject: '' visible_subject: '' rc_center: '' ei_cassa_type: null ei_withholding_tax_causal: null ei_other_withholding_tax_type: null ei_other_withholding_tax_causal: null stamp_duty: 0 use_gross_prices: false e_invoice: false agyo_company_id: null agyo_id: null agyo_sent_at: null delivery_note: false accompanying_invoice: false amount_net: 68.18 amount_vat: 6.82 amount_gross: 75 amount_due_discount: 0 amount_rivalsa: 0 amount_cassa: 0 amount_withholding_tax: 0 amount_other_withholding_tax: 0 h_margins: 15 v_margins: 16 show_payment_method: false show_payments: true show_totals: all show_notification_button: false is_marked: false created_at: '2022-08-13 09:30:20' updated_at: '2022-08-23 05:34:20' entity: id: 54321 name: Mary Red S.r.L. vat_number: IT05432181211 tax_code: IT05432181211 address_street: Via Italia, 66 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia certified_email: mary@pec.red.com ei_code: ABCXCR1 date: '2021-08-20' number: 1 currency: id: EUR exchange_rate: '1.00000' symbol: € language: code: it name: Italiano notes: '' rivalsa: 0 cassa: 0 withholding_tax: 0 withholding_tax_taxable: 100 other_withholding_tax: 0 payment_method: id: 4 name: Credit card use_split_payment: false merged_in: null original_document: null items_list: - product_id: 5432 code: SG3 name: Soggiorno measure: '' net_price: 68.18182 category: '' id: 277876033 gross_price: 75 apply_withholding_taxes: true discount: 0 discount_highlight: false in_dn: false qty: 1 vat: id: 3 value: 10 description: '' stock: false description: '' not_taxable: false payments_list: - amount: 75 due_date: '2020-08-23' paid_date: null id: 69078013 payment_terms: days: 0 type: standard status: not_paid attachment_url: kdijrnf893hnwkfk45f50f.pdf seen_date: null next_due_date: '2020-08-23' template: id: 2821 name: Light Smoke extra_data: null url: y12h45rn9yf2mse0p43t7ec90vr.pdf locked: false has_ts_pay_pending_payment: false show_tspay_button: false options: create_from: - '82112399' transform: true keep_copy: true JoinIssuedDocumentsResponse: description: Example response content: application/json: schema: title: JoinIssuedDocumentsResponse type: object properties: data: title: IssuedDocument type: object properties: id: type: integer description: Issued document id nullable: true entity: title: Entity type: object properties: id: type: integer nullable: true description: Entity id code: type: string example: '123' description: Entity code nullable: true name: type: string example: Rossi S.r.l. description: Entity name nullable: true type: title: EntityType type: string nullable: true default: null enum: - company - person - pa - condo description: Entity type first_name: type: string description: Entity first name nullable: true last_name: type: string description: Entity last name nullable: true contact_person: type: string nullable: true description: Entity contact person vat_number: type: string example: IT01234567890 description: Entity vat number nullable: true tax_code: type: string example: RSSMRA44A12E890Q description: Entity tax code nullable: true address_street: type: string example: Via dei tigli, 12 description: Entitity address street nullable: true address_postal_code: type: string example: '24010' nullable: true description: Entity address postal code address_city: type: string example: Bergamo description: Entity address city nullable: true address_province: type: string example: BG description: Entity address province nullable: true address_extra: type: string description: Entity address extra info nullable: true country: type: string example: Italia description: Entity country nullable: true country_iso: type: string example: Italia description: Entity country iso code nullable: true email: type: string example: mario.rossi@example.it description: Entity email nullable: true certified_email: type: string example: mario.rossi@pec.example.it description: Entity certified email nullable: true phone: type: string nullable: true description: Entity phone fax: type: string nullable: true description: Entity fax notes: type: string description: Entity extra nullable: true default_payment_terms: type: integer example: 30 description: |- [Only for client] Client default payment terms nullable: true default_vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true description: |- [Only for client] Client default vat. default_payment_terms_type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: |- [Only for client] Client default payment terms type default_payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true description: |- [Only for client] Client default payment method bank_name: type: string description: |- [Only for client] Client bank name nullable: true bank_iban: type: string description: |- [Only for client] Client bank iban nullable: true bank_swift_code: type: string description: |- [Only for client] Client bank swift code nullable: true shipping_address: type: string description: |- [Only for client] Client Shipping address nullable: true e_invoice: type: boolean description: |- [Only for client] Use e-invoices. nullable: true ei_code: type: string description: |- [Only for client] E-invoices code. nullable: true has_intent_declaration: type: boolean description: |- [Only for client] Has intent declaration. nullable: true intent_declaration_protocol_number: type: string description: |- [Only for client] Client intent declaration protocol number nullable: true intent_declaration_protocol_date: type: string format: date description: |- [Only for client] Client intent declaration protocol date nullable: true created_at: type: string nullable: true description: Entity creation date updated_at: type: string nullable: true description: Entity last update date type: type: string default: invoice enum: - invoice - quote - proforma - receipt - delivery_note - credit_note - order - work_report - supplier_order - self_own_invoice - self_supplier_invoice description: Issued document type number: type: integer description: |- Issued document number [If not specified, next number is used] example: 1 nullable: true numeration: type: string description: |- Issued document numeration [Not available if type=delivery_note] example: /A nullable: true date: type: string description: |- Issued document date [defaults to today's date] format: date nullable: true year: type: integer description: Issued document year nullable: true currency: type: object title: Currency properties: id: type: string description: Currency code example: EUR nullable: true symbol: type: string description: Currency symbol example: € nullable: true exchange_rate: type: string nullable: true description: Currency exchange rate (EUR to this) example: '1' html_symbol: type: string example: EUR description: Currency html code nullable: true language: type: object title: Language properties: code: type: string description: Language code nullable: true name: type: string description: Language extended name nullable: true subject: type: string description: Issued document subject nullable: true visible_subject: type: string description: Issued document visible subject nullable: true rc_center: type: string description: >- Issued document revenue center [or cost center if type=supplier_order]. nullable: true notes: type: string description: Issued document extra notes nullable: true rivalsa: type: number description: Issued document "Rivalsa INPS" percentual value nullable: true cassa: type: number description: Issued document "Cassa previdenziale" percentual value nullable: true amount_cassa: type: number description: |- [Read Only] Issued document cassa amount. nullable: true readOnly: true cassa_taxable: type: number description: Issued document cassa taxable percentage nullable: true amount_cassa_taxable: type: number nullable: true description: |- [Can be set only if cassa_taxable is NULL] Issued document cassa taxable amount cassa2: type: number description: Issued document "Cassa previdenziale 2" percentual value nullable: true amount_cassa2: type: number nullable: true description: |- [Read Only] Issued document cassa2 amount readOnly: true cassa2_taxable: type: number description: Issued document cassa2 taxable percentage nullable: true amount_cassa2_taxable: type: number nullable: true description: |- [Can be set only if cassa2_taxable is NULL] Issued document cassa2 taxable amount global_cassa_taxable: type: number description: Issued document global cassa taxable percentage nullable: true amount_global_cassa_taxable: type: number nullable: true description: |- [Can be set only if global_cassa_taxable is NULL] Issued document global cassa taxable amount withholding_tax: type: number description: >- Issued document withholding tax (ritenuta d'acconto) percentual value nullable: true withholding_tax_taxable: type: number description: >- Issued document withholding tax taxable (imponibile) percentual value nullable: true other_withholding_tax: type: number description: >- Issued document other withholding tax (altra ritenuta) percentual value nullable: true stamp_duty: type: number description: |- Issued document stamp duty value [0 if not present] nullable: true payment_method: type: object title: PaymentMethod properties: id: type: integer nullable: true description: Payment method id name: type: string description: Payment method name nullable: true type: title: PaymentMethodType type: string description: Payment method type default: standard enum: - standard - riba is_default: type: boolean nullable: true description: Payment method is default default_payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true details: maxItems: 5 type: array nullable: true description: Payment method details items: title: PaymentMethodDetails type: object properties: title: type: string description: Payment method details title nullable: true description: type: string description: Payment method details description nullable: true bank_iban: type: string description: Payment method bank iban nullable: true bank_name: type: string description: Payment method bank name nullable: true bank_beneficiary: type: string description: Payment method bank beneficiary nullable: true ei_payment_method: type: string description: E-invoice payment method nullable: true use_split_payment: type: boolean description: Issued document uses split payment nullable: true use_gross_prices: type: boolean description: Issued document uses gross prices nullable: true e_invoice: type: boolean description: Issued document is an e-invoice. nullable: true ei_data: type: object nullable: true description: |- Issued document e-invoice data [Only if e_invoice=true] properties: vat_kind: title: VatKind type: string nullable: true description: Vat kind [esigibilità IVA] default: null enum: - null - I - D - S original_document_type: title: OriginalDocumentType type: string nullable: true description: Issued document original document type default: null enum: - ordine - contratto - convenzione od_number: type: string nullable: true description: E-invoice original document number od_date: type: string description: E-invoice original document date format: date nullable: true cig: type: string nullable: true description: E-invoice CIG cup: type: string nullable: true description: E-invoice CUP payment_method: type: string nullable: true description: >- E-invoice payment method [required for e-invoices] (see [here](https://www.fatturapa.gov.it/export/documenti/fatturapa/v1.2.2/Rappresentazione_Tabellare_FattOrdinaria_V1.2.2.pdf) for the accepted values of ModalitaPagamento) bank_name: type: string nullable: true description: E-invoice bank name bank_iban: type: string nullable: true description: E-invoice bank IBAN bank_beneficiary: type: string nullable: true description: E-invoice bank beneficiary invoice_number: type: string description: E-invoice invoice number nullable: true invoice_date: type: string format: date description: E-invoice invoice date nullable: true ei_cassa_type: type: string nullable: true description: E-invoice cassa type ei_cassa2_type: type: string nullable: true description: E-invoice cassa2 type ei_withholding_tax_causal: type: string nullable: true description: E-invoice withholding tax causal ei_other_withholding_tax_type: type: string nullable: true description: E-invoice other withholding tax type ei_other_withholding_tax_causal: type: string nullable: true description: E-invoice other withholding tax causal items_list: type: array nullable: true items: title: IssuedDocumentItemsListItem type: object properties: id: type: integer description: Issued document item id nullable: true product_id: type: integer nullable: true description: Issued document item product id example: 1234 code: type: string description: Issued document item product code example: '239874892374982' nullable: true name: type: string description: Issued document item product name example: Water bottle nullable: true category: type: string description: Issued document item product category nullable: true description: type: string description: Issued document product description nullable: true qty: type: number description: Issued document item quantity nullable: true measure: type: string description: Issued document item measure nullable: true net_price: type: number description: Issued document item net price example: 1.23 nullable: true gross_price: type: number nullable: true example: 1.45 description: Issued document item gross price vat: type: object nullable: true title: VatType properties: id: type: integer description: Vat type id nullable: true value: type: number description: '[Read Only] Vat type percentual value' example: 22 nullable: true description: type: string description: Vat type short description example: Non imponibile art. 123 nullable: true notes: type: string description: Vat type notes shown in documents example: >- IVA non imponibile ai sensi dell'articolo 123, comma 2 nullable: true e_invoice: type: boolean description: Vat type is usable for e-invoices nullable: true ei_type: type: string description: Vat type e-invoice type (natura) example: 2 nullable: true ei_description: type: string description: Vat type e-invoice description nullable: true editable: type: boolean description: |- [Read Only] Is the vat type is editable. nullable: true readOnly: true is_disabled: type: boolean description: Is the vat type disabled nullable: true not_taxable: type: boolean nullable: true description: Issued document item is not taxable apply_withholding_taxes: type: boolean description: >- Issued document item apply withholding taxes, rivalsa and cassa nullable: true discount: type: number description: Issued document item discount percentual value nullable: true discount_highlight: type: boolean nullable: true description: Issued document item highlight discount in_dn: type: boolean nullable: true description: Issued document item add in delivery note stock: type: boolean nullable: true description: Issued document item move stock ei_raw: type: object description: >- Issued document advanced raw attributes for e-invoices nullable: true payments_list: type: array nullable: true items: title: IssuedDocumentPaymentsListItem type: object properties: id: type: integer description: Issued document payment item id nullable: true due_date: type: string description: Issued document payment due date format: date example: '2018-04-03' nullable: true amount: type: number description: Issued document payment amount example: 1.45 nullable: true status: title: IssuedDocumentStatus type: string description: Issued document status default: not_paid enum: - not_paid - paid - reversed payment_account: type: object nullable: true title: PaymentAccount properties: id: type: integer description: Payment account id nullable: true name: type: string description: Payment account name example: Conto Banca Intesa nullable: true type: title: PaymentAccountType type: string default: standard enum: - standard - bank description: Payment account type iban: type: string nullable: true description: Payment account iban sia: type: string nullable: true description: Payment account sia cuc: type: string description: Payment account cuc nullable: true virtual: type: boolean description: Payment method is virtual nullable: true paid_date: type: string description: |- Issued document payment date [Only if status is paid] format: date example: '2018-04-03' nullable: true ei_raw: type: object nullable: true description: >- Issued document payment advanced raw attributes for e-invoices payment_terms: type: object properties: days: type: integer nullable: true description: >- Issued document payment number of days by which the payment must be made type: title: PaymentTermsType type: string default: standard enum: - standard - end_of_month description: Payment terms type template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true delivery_note_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true acc_inv_template: type: object title: DocumentTemplate properties: id: type: integer description: Template id example: 123 nullable: true name: type: string example: Light Smoke nullable: true description: Template name type: type: string description: Template type nullable: true h_margins: type: integer description: Issued document PDF horizontal margins nullable: true v_margins: type: integer description: Issued document PDF vertical margins nullable: true show_payments: type: boolean description: Show the expiration dates of the payments on the document nullable: true show_payment_method: type: boolean description: Show the payment method details on the document nullable: true show_totals: title: ShowTotalsMode type: string description: Show totals mode default: all enum: - none - nets - all show_notification_button: type: boolean description: Show notification button in the PDF nullable: true show_tspay_button: type: boolean description: Show ts pay button in the PDF nullable: true delivery_note: type: boolean nullable: true description: Issued document has delivery note accompanying_invoice: type: boolean description: Issued document has an accompanying invoice nullable: true dn_number: type: integer description: Issued document attached delivery note number nullable: true dn_date: type: string description: Issued document attached delivery note date format: date nullable: true dn_ai_packages_number: type: string nullable: true description: Issued document attached delivery note number of packages dn_ai_weight: type: string nullable: true description: Issued document attached delivery note package weight dn_ai_causal: type: string nullable: true description: Issued document attached delivery note causal dn_ai_destination: type: string nullable: true description: Issued document attached delivery note destination dn_ai_transporter: type: string nullable: true description: Issued document attached delivery note transporter dn_ai_notes: type: string nullable: true description: Issued document attached delivery note notes is_marked: type: boolean description: Issued document is marked nullable: true amount_net: type: number description: |- [Read only] Issued document total net amount nullable: true readOnly: true amount_vat: type: number description: |- [Read Only] Issued document total vat amount nullable: true readOnly: true amount_gross: type: number description: |- [Read Only] Issued document total gross amount nullable: true readOnly: true amount_due_discount: type: number description: Issued document amount due discount nullable: true amount_rivalsa: type: number description: |- [Read Only] Issued document rivalsa amount nullable: true readOnly: true amount_rivalsa_taxable: type: number nullable: true description: Issued document taxable rivalsa amount amount_withholding_tax: type: number description: >- [Read Only] Issued document withholding tax amount (ritenuta d'acconto). nullable: true readOnly: true amount_withholding_tax_taxable: type: number nullable: true description: Issued document taxable withholding tax amount amount_other_withholding_tax: type: number description: >- [Read Only] Issued document other withholding tax amount (altra ritenuta) nullable: true readOnly: true amount_other_withholding_tax_taxable: type: number nullable: true description: Issued document taxable other withholding tax amount amount_enasarco_taxable: type: number nullable: true description: Issued document taxable enasarco amount extra_data: type: object nullable: true description: >- Issued document extra data [TS fields follow the technical specifications provided by "Sistema Tessera Sanitaria"] properties: multifatture_sent: type: integer nullable: true ts_communication: type: boolean nullable: true description: Send issued document to "Sistema Tessera Sanitaria" ts_flag_tipo_spesa: type: number nullable: true description: >- Issued document ts "tipo spesa" [TK, FC, FV, SV,SP, AD, AS, ECG, SR] ts_pagamento_tracciato: type: boolean nullable: true description: Issued document ts traced payment ts_tipo_spesa: type: string description: >- Can be [ 'TK', 'FC', 'FV', 'SV', 'SP', 'AD', 'AS', 'SR', 'CT', 'PI', 'IC', 'AA' ]. Refer to the technical specifications to learn more. nullable: true ts_opposizione: type: boolean nullable: true description: Issued document ts "opposizione" ts_status: type: integer nullable: true description: Issued document ts status ts_file_id: type: string nullable: true description: Issued document ts file id ts_sent_date: type: string nullable: true format: date description: Issued document ts sent date ts_full_amount: type: boolean nullable: true description: Issued document ts total amount imported_by: type: string nullable: true description: Issued document imported by software seen_date: type: string nullable: true description: Issued document seen date format: date next_due_date: type: string nullable: true description: Issued document date of the next not paid payment format: date url: type: string description: |- [Temporary] [Read Only] Issued document url of the document PDF file nullable: true dn_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached delivery note PDF file nullable: true ai_url: type: string description: |- [Temporary] [Read Only] Issued document url of the accompanying invoice PDF file nullable: true attachment_url: type: string description: |- [Temporary] [Read Only] Issued document url of the attached file nullable: true readOnly: true attachment_token: type: string nullable: true description: >- [Write Only] Issued document attachment token returned by POST /issued_documents/attachment writeOnly: true ei_raw: type: object nullable: true description: Issued document advanced raw attributes for e-invoices ei_status: type: string description: | [Read only] Status of the e-invoice. * **attempt** - We are trying to send the invoice, please wait up to 2 hours * **missing** - The invoice is missing * **not_sent** - The invoice has yet to be sent * **sent** - The invoice was sent * **pending** - The checks for the digital signature and sending are in progress * **processing** - The SDI is delivering the invoice to the customer * **error** - An error occurred while handling the invoice, please try to resend it or contact support * **discarded** - The invoice has been rejected by the SDI, so it must be corrected and re-sent * **not_delivered** - The SDI was unable to deliver the invoice * **accepted** - The customer accepted the invoice * **rejected** - The customer rejected the invoice, so it must be corrected * **no_response** - A response has not yet been received whithin the deadline, contact the customer to ascertain the status of the invoice * **manual_accepted** - The customer accepted the invoice * **manual_rejected** - The customer rejected the invoice enum: - attempt - missing - not_sent - sent - pending - processing - error - discarded - not_delivered - accepted - rejected - no_response - manual_accepted - manual_rejected nullable: true locked: type: boolean nullable: true description: Issued Document can't be edited created_at: type: string nullable: true description: Issued document creation date updated_at: type: string nullable: true description: Issued document last update date nullable: true options: title: IssuedDocumentOptions type: object properties: fix_payments: type: boolean description: >- Fixes your last payment amount to match your document total nullable: true create_from: type: array description: Original documents ids [only for join/transform] nullable: true items: type: string transform: type: boolean description: Tranform a document [only for transform] nullable: true keep_copy: type: boolean description: Keep original document [only for transform] nullable: true join_type: type: string description: Join type [only for join] nullable: true nullable: true examples: example-1: value: data: type: invoice year: 2022 numeration: '' subject: '' visible_subject: '' rc_center: '' ei_cassa_type: null ei_withholding_tax_causal: null ei_other_withholding_tax_type: null ei_other_withholding_tax_causal: null stamp_duty: 0 use_gross_prices: false e_invoice: false agyo_company_id: null agyo_id: null agyo_sent_at: null delivery_note: false accompanying_invoice: false amount_net: 68.18 amount_vat: 6.82 amount_gross: 75 amount_due_discount: 0 amount_rivalsa: 0 amount_cassa: 0 amount_withholding_tax: 0 amount_other_withholding_tax: 0 h_margins: 15 v_margins: 16 show_payment_method: false show_payments: true show_totals: all show_notification_button: false is_marked: false created_at: '2022-08-13 09:30:20' updated_at: '2022-08-23 05:34:20' entity: id: 54321 name: Mary Red S.r.L. vat_number: IT05432181211 tax_code: IT05432181211 address_street: Via Italia, 66 address_postal_code: '20900' address_city: Milano address_province: MI address_extra: '' country: Italia certified_email: mary@pec.red.com ei_code: ABCXCR1 date: '2021-08-20' number: 1 currency: id: EUR exchange_rate: '1.00000' symbol: € language: code: it name: Italiano notes: '' rivalsa: 0 cassa: 0 withholding_tax: 0 withholding_tax_taxable: 100 other_withholding_tax: 0 payment_method: id: 4 name: Credit card use_split_payment: false merged_in: null original_document: null items_list: - product_id: 5432 code: SG3 name: Soggiorno measure: '' net_price: 68.18182 category: '' id: 277876033 gross_price: 75 apply_withholding_taxes: true discount: 0 discount_highlight: false in_dn: false qty: 1 vat: id: 3 value: 10 description: '' stock: false description: '' not_taxable: false payments_list: - amount: 75 due_date: '2020-08-23' paid_date: null id: 69078013 payment_terms: days: 0 type: standard status: not_paid attachment_url: kdijrnf893hnwkfk45f50f.pdf seen_date: null next_due_date: '2020-08-23' template: id: 2821 name: Light Smoke extra_data: null url: y12h45rn9yf2mse0p43t7ec90vr.pdf locked: false has_ts_pay_pending_payment: false show_tspay_button: false options: create_from: - '82112399' - '82112400' ListEmailsResponse: description: Example response content: application/json: schema: title: ListEmailsResponse allOf: - title: Pagination type: object description: '' properties: current_page: type: integer description: Current page number. nullable: true first_page_url: type: string format: uri description: First page url. nullable: true from: type: integer nullable: true description: First result of the page. last_page: type: integer description: Last page number. nullable: true last_page_url: type: string format: uri description: Last page url. nullable: true next_page_url: type: string format: uri nullable: true description: Next page url path: type: string format: uri description: Request path. nullable: true per_page: type: integer description: Number of result per page. nullable: true prev_page_url: type: string format: uri nullable: true description: Previous page url. to: type: integer nullable: true description: Last result of the page. total: type: integer description: Total number of results nullable: true - title: ListEmailsResponsePage type: object properties: data: type: array items: title: Email type: object properties: id: type: integer nullable: true description: Email id status: type: string title: EmailStatus description: Email status enum: - sending - pending - sent sent_date: type: string format: date-time nullable: true description: Email sent date errors_count: type: integer nullable: true description: Email errors count error_log: type: string nullable: true description: Email errors log from_email: type: string nullable: true description: Email sender email from_name: type: string nullable: true description: Email sender name to_email: type: string nullable: true description: Email recipient email to_name: type: string nullable: true description: Email receipient name subject: type: string nullable: true description: Email subject content: type: string nullable: true description: Email content copy_to: type: string nullable: true description: Email cc recipient_status: type: string title: EmailRecipientStatus description: Email recipient status enum: - unknown - document_opened - email_opened recipient_date: type: string format: date-time nullable: true description: Email recipient date kind: type: string nullable: true description: Email kind attachments: type: array nullable: true description: Email attachments items: title: EmailAttachment type: object properties: filename: type: string description: Email attachment filename url: type: string description: Email attachment url examples: example-1: value: current_page: 1 data: - id: 1 status: sent sent_date: '2022-07-17 13:53:12' errors_count: 0 error_log: '' from_email: test@mail.it from_name: Test mail to_email: mail@test.it to_name: Mario subject: Test content: Test send email copy_to: '' recipient_status: unknown recipient_date: null kind: Fatture attachments: [] - id: 2 status: sent sent_date: '2022-07-18 13:53:12' errors_count: 0 error_log: '' from_email: test@mail.it from_name: Test mail to_email: mail@test.it to_name: Maria subject: Test content: Test send email copy_to: '' recipient_status: unknown recipient_date: null kind: Fatture attachments: [] first_page_url: emails?page=1 from: 1 last_page: 1 last_page_url: emails?page=1 next_page_url: null path: emails per_page: 50 prev_page_url: null to: 2 total: 2 CreateWebhooksSubscriptionResponse: description: Example response content: application/json: schema: title: CreateWebhooksSubscriptionResponse type: object properties: data: title: WebhooksSubscription type: object properties: id: type: string nullable: true description: Webhooks subscription id sink: type: string nullable: true description: Webhooks callback uri. verified: type: boolean nullable: true description: >- [Read Only] True if the webhooks subscription has been verified. types: type: array nullable: true description: Webhooks events types. items: type: string title: EventType description: Webhooks event type enum: - >- it.fattureincloud.webhooks.issued_documents.invoices.create - >- it.fattureincloud.webhooks.issued_documents.invoices.update - >- it.fattureincloud.webhooks.issued_documents.invoices.delete - >- it.fattureincloud.webhooks.issued_documents.quotes.create - >- it.fattureincloud.webhooks.issued_documents.quotes.update - >- it.fattureincloud.webhooks.issued_documents.quotes.delete - >- it.fattureincloud.webhooks.issued_documents.proformas.create - >- it.fattureincloud.webhooks.issued_documents.proformas.update - >- it.fattureincloud.webhooks.issued_documents.proformas.delete - >- it.fattureincloud.webhooks.issued_documents.receipts.create - >- it.fattureincloud.webhooks.issued_documents.receipts.update - >- it.fattureincloud.webhooks.issued_documents.receipts.delete - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.create - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.update - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.delete - >- it.fattureincloud.webhooks.issued_documents.credit_notes.create - >- it.fattureincloud.webhooks.issued_documents.credit_notes.update - >- it.fattureincloud.webhooks.issued_documents.credit_notes.delete - >- it.fattureincloud.webhooks.issued_documents.orders.create - >- it.fattureincloud.webhooks.issued_documents.orders.update - >- it.fattureincloud.webhooks.issued_documents.orders.delete - >- it.fattureincloud.webhooks.issued_documents.work_reports.create - >- it.fattureincloud.webhooks.issued_documents.work_reports.update - >- it.fattureincloud.webhooks.issued_documents.work_reports.delete - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.create - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.update - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.delete - >- it.fattureincloud.webhooks.issued_documents.self_invoices.create - >- it.fattureincloud.webhooks.issued_documents.self_invoices.update - >- it.fattureincloud.webhooks.issued_documents.self_invoices.delete - it.fattureincloud.webhooks.issued_documents.all.create - it.fattureincloud.webhooks.issued_documents.all.update - it.fattureincloud.webhooks.issued_documents.all.delete - it.fattureincloud.webhooks.received_documents.create - it.fattureincloud.webhooks.received_documents.update - it.fattureincloud.webhooks.received_documents.delete - it.fattureincloud.webhooks.receipts.create - it.fattureincloud.webhooks.receipts.update - it.fattureincloud.webhooks.receipts.delete - it.fattureincloud.webhooks.taxes.create - it.fattureincloud.webhooks.taxes.update - it.fattureincloud.webhooks.taxes.delete - it.fattureincloud.webhooks.archive_documents.create - it.fattureincloud.webhooks.archive_documents.update - it.fattureincloud.webhooks.archive_documents.delete - it.fattureincloud.webhooks.cashbook.create - it.fattureincloud.webhooks.cashbook.update - it.fattureincloud.webhooks.cashbook.delete - it.fattureincloud.webhooks.products.create - it.fattureincloud.webhooks.products.update - it.fattureincloud.webhooks.products.delete - it.fattureincloud.webhooks.products.stock_update - it.fattureincloud.webhooks.entities.clients.create - it.fattureincloud.webhooks.entities.clients.update - it.fattureincloud.webhooks.entities.clients.delete - it.fattureincloud.webhooks.entities.suppliers.create - it.fattureincloud.webhooks.entities.suppliers.update - it.fattureincloud.webhooks.entities.suppliers.delete - it.fattureincloud.webhooks.entities.all.create - it.fattureincloud.webhooks.entities.all.update - it.fattureincloud.webhooks.entities.all.delete - >- it.fattureincloud.webhooks.issued_documents.e_invoices.status_update - >- it.fattureincloud.webhooks.received_documents.e_invoices.receive config: title: WebhooksSubscriptionConfig type: object properties: mapping: title: WebhooksSubscriptionMapping type: string description: Determines the webhook payload shape enum: - binary - structured warnings: type: array nullable: true description: Webhooks registration warnings items: type: string examples: example-1: value: data: id: SUB123 sink: http://www.test.com verified: true types: - it.fattureincloud.webhooks.entities.create - it.fattureincloud.webhooks.issued_documents.create warnings: >- The 'it.fattureincloud.webhooks.entities.clients.delete' event is already registered for this application ListWebhooksSubscriptionsResponse: description: Example response content: application/json: schema: title: ListWebhooksSubscriptionsResponse type: object properties: data: type: array items: title: WebhooksSubscription type: object properties: id: type: string nullable: true description: Webhooks subscription id sink: type: string nullable: true description: Webhooks callback uri. verified: type: boolean nullable: true description: >- [Read Only] True if the webhooks subscription has been verified. types: type: array nullable: true description: Webhooks events types. items: type: string title: EventType description: Webhooks event type enum: - >- it.fattureincloud.webhooks.issued_documents.invoices.create - >- it.fattureincloud.webhooks.issued_documents.invoices.update - >- it.fattureincloud.webhooks.issued_documents.invoices.delete - >- it.fattureincloud.webhooks.issued_documents.quotes.create - >- it.fattureincloud.webhooks.issued_documents.quotes.update - >- it.fattureincloud.webhooks.issued_documents.quotes.delete - >- it.fattureincloud.webhooks.issued_documents.proformas.create - >- it.fattureincloud.webhooks.issued_documents.proformas.update - >- it.fattureincloud.webhooks.issued_documents.proformas.delete - >- it.fattureincloud.webhooks.issued_documents.receipts.create - >- it.fattureincloud.webhooks.issued_documents.receipts.update - >- it.fattureincloud.webhooks.issued_documents.receipts.delete - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.create - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.update - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.delete - >- it.fattureincloud.webhooks.issued_documents.credit_notes.create - >- it.fattureincloud.webhooks.issued_documents.credit_notes.update - >- it.fattureincloud.webhooks.issued_documents.credit_notes.delete - >- it.fattureincloud.webhooks.issued_documents.orders.create - >- it.fattureincloud.webhooks.issued_documents.orders.update - >- it.fattureincloud.webhooks.issued_documents.orders.delete - >- it.fattureincloud.webhooks.issued_documents.work_reports.create - >- it.fattureincloud.webhooks.issued_documents.work_reports.update - >- it.fattureincloud.webhooks.issued_documents.work_reports.delete - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.create - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.update - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.delete - >- it.fattureincloud.webhooks.issued_documents.self_invoices.create - >- it.fattureincloud.webhooks.issued_documents.self_invoices.update - >- it.fattureincloud.webhooks.issued_documents.self_invoices.delete - >- it.fattureincloud.webhooks.issued_documents.all.create - >- it.fattureincloud.webhooks.issued_documents.all.update - >- it.fattureincloud.webhooks.issued_documents.all.delete - it.fattureincloud.webhooks.received_documents.create - it.fattureincloud.webhooks.received_documents.update - it.fattureincloud.webhooks.received_documents.delete - it.fattureincloud.webhooks.receipts.create - it.fattureincloud.webhooks.receipts.update - it.fattureincloud.webhooks.receipts.delete - it.fattureincloud.webhooks.taxes.create - it.fattureincloud.webhooks.taxes.update - it.fattureincloud.webhooks.taxes.delete - it.fattureincloud.webhooks.archive_documents.create - it.fattureincloud.webhooks.archive_documents.update - it.fattureincloud.webhooks.archive_documents.delete - it.fattureincloud.webhooks.cashbook.create - it.fattureincloud.webhooks.cashbook.update - it.fattureincloud.webhooks.cashbook.delete - it.fattureincloud.webhooks.products.create - it.fattureincloud.webhooks.products.update - it.fattureincloud.webhooks.products.delete - it.fattureincloud.webhooks.products.stock_update - it.fattureincloud.webhooks.entities.clients.create - it.fattureincloud.webhooks.entities.clients.update - it.fattureincloud.webhooks.entities.clients.delete - it.fattureincloud.webhooks.entities.suppliers.create - it.fattureincloud.webhooks.entities.suppliers.update - it.fattureincloud.webhooks.entities.suppliers.delete - it.fattureincloud.webhooks.entities.all.create - it.fattureincloud.webhooks.entities.all.update - it.fattureincloud.webhooks.entities.all.delete - >- it.fattureincloud.webhooks.issued_documents.e_invoices.status_update - >- it.fattureincloud.webhooks.received_documents.e_invoices.receive config: title: WebhooksSubscriptionConfig type: object properties: mapping: title: WebhooksSubscriptionMapping type: string description: Determines the webhook payload shape enum: - binary - structured examples: example-1: value: data: - id: SUB12345 sink: https://www.testurl.com/endpoint verified: true types: - it.fattureincloud.webhooks.issued_documents.create - it.fattureincloud.webhooks.issued_documents.update - id: SUB12346 sink: https://www.testurl.com/endpoint2 verified: true types: - it.fattureincloud.webhooks.issued_documents.delete GetWebhooksSubscriptionResponse: description: Example response content: application/json: schema: title: GetWebhooksSubscriptionResponse type: object properties: data: title: WebhooksSubscription type: object properties: id: type: string nullable: true description: Webhooks subscription id sink: type: string nullable: true description: Webhooks callback uri. verified: type: boolean nullable: true description: >- [Read Only] True if the webhooks subscription has been verified. types: type: array nullable: true description: Webhooks events types. items: type: string title: EventType description: Webhooks event type enum: - >- it.fattureincloud.webhooks.issued_documents.invoices.create - >- it.fattureincloud.webhooks.issued_documents.invoices.update - >- it.fattureincloud.webhooks.issued_documents.invoices.delete - >- it.fattureincloud.webhooks.issued_documents.quotes.create - >- it.fattureincloud.webhooks.issued_documents.quotes.update - >- it.fattureincloud.webhooks.issued_documents.quotes.delete - >- it.fattureincloud.webhooks.issued_documents.proformas.create - >- it.fattureincloud.webhooks.issued_documents.proformas.update - >- it.fattureincloud.webhooks.issued_documents.proformas.delete - >- it.fattureincloud.webhooks.issued_documents.receipts.create - >- it.fattureincloud.webhooks.issued_documents.receipts.update - >- it.fattureincloud.webhooks.issued_documents.receipts.delete - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.create - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.update - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.delete - >- it.fattureincloud.webhooks.issued_documents.credit_notes.create - >- it.fattureincloud.webhooks.issued_documents.credit_notes.update - >- it.fattureincloud.webhooks.issued_documents.credit_notes.delete - >- it.fattureincloud.webhooks.issued_documents.orders.create - >- it.fattureincloud.webhooks.issued_documents.orders.update - >- it.fattureincloud.webhooks.issued_documents.orders.delete - >- it.fattureincloud.webhooks.issued_documents.work_reports.create - >- it.fattureincloud.webhooks.issued_documents.work_reports.update - >- it.fattureincloud.webhooks.issued_documents.work_reports.delete - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.create - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.update - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.delete - >- it.fattureincloud.webhooks.issued_documents.self_invoices.create - >- it.fattureincloud.webhooks.issued_documents.self_invoices.update - >- it.fattureincloud.webhooks.issued_documents.self_invoices.delete - it.fattureincloud.webhooks.issued_documents.all.create - it.fattureincloud.webhooks.issued_documents.all.update - it.fattureincloud.webhooks.issued_documents.all.delete - it.fattureincloud.webhooks.received_documents.create - it.fattureincloud.webhooks.received_documents.update - it.fattureincloud.webhooks.received_documents.delete - it.fattureincloud.webhooks.receipts.create - it.fattureincloud.webhooks.receipts.update - it.fattureincloud.webhooks.receipts.delete - it.fattureincloud.webhooks.taxes.create - it.fattureincloud.webhooks.taxes.update - it.fattureincloud.webhooks.taxes.delete - it.fattureincloud.webhooks.archive_documents.create - it.fattureincloud.webhooks.archive_documents.update - it.fattureincloud.webhooks.archive_documents.delete - it.fattureincloud.webhooks.cashbook.create - it.fattureincloud.webhooks.cashbook.update - it.fattureincloud.webhooks.cashbook.delete - it.fattureincloud.webhooks.products.create - it.fattureincloud.webhooks.products.update - it.fattureincloud.webhooks.products.delete - it.fattureincloud.webhooks.products.stock_update - it.fattureincloud.webhooks.entities.clients.create - it.fattureincloud.webhooks.entities.clients.update - it.fattureincloud.webhooks.entities.clients.delete - it.fattureincloud.webhooks.entities.suppliers.create - it.fattureincloud.webhooks.entities.suppliers.update - it.fattureincloud.webhooks.entities.suppliers.delete - it.fattureincloud.webhooks.entities.all.create - it.fattureincloud.webhooks.entities.all.update - it.fattureincloud.webhooks.entities.all.delete - >- it.fattureincloud.webhooks.issued_documents.e_invoices.status_update - >- it.fattureincloud.webhooks.received_documents.e_invoices.receive config: title: WebhooksSubscriptionConfig type: object properties: mapping: title: WebhooksSubscriptionMapping type: string description: Determines the webhook payload shape enum: - binary - structured examples: example-1: value: data: id: SUB123 sink: https://test.url verified: true types: - >- it.fattureincloud.webhooks.issued_documents.invoices.create ModifyWebhooksSubscriptionResponse: description: Example response content: application/json: schema: title: CreateWebhooksSubscriptionRequest type: object properties: data: title: WebhooksSubscription type: object properties: id: type: string nullable: true description: Webhooks subscription id sink: type: string nullable: true description: Webhooks callback uri. verified: type: boolean nullable: true description: >- [Read Only] True if the webhooks subscription has been verified. types: type: array nullable: true description: Webhooks events types. items: type: string title: EventType description: Webhooks event type enum: - >- it.fattureincloud.webhooks.issued_documents.invoices.create - >- it.fattureincloud.webhooks.issued_documents.invoices.update - >- it.fattureincloud.webhooks.issued_documents.invoices.delete - >- it.fattureincloud.webhooks.issued_documents.quotes.create - >- it.fattureincloud.webhooks.issued_documents.quotes.update - >- it.fattureincloud.webhooks.issued_documents.quotes.delete - >- it.fattureincloud.webhooks.issued_documents.proformas.create - >- it.fattureincloud.webhooks.issued_documents.proformas.update - >- it.fattureincloud.webhooks.issued_documents.proformas.delete - >- it.fattureincloud.webhooks.issued_documents.receipts.create - >- it.fattureincloud.webhooks.issued_documents.receipts.update - >- it.fattureincloud.webhooks.issued_documents.receipts.delete - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.create - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.update - >- it.fattureincloud.webhooks.issued_documents.delivery_notes.delete - >- it.fattureincloud.webhooks.issued_documents.credit_notes.create - >- it.fattureincloud.webhooks.issued_documents.credit_notes.update - >- it.fattureincloud.webhooks.issued_documents.credit_notes.delete - >- it.fattureincloud.webhooks.issued_documents.orders.create - >- it.fattureincloud.webhooks.issued_documents.orders.update - >- it.fattureincloud.webhooks.issued_documents.orders.delete - >- it.fattureincloud.webhooks.issued_documents.work_reports.create - >- it.fattureincloud.webhooks.issued_documents.work_reports.update - >- it.fattureincloud.webhooks.issued_documents.work_reports.delete - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.create - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.update - >- it.fattureincloud.webhooks.issued_documents.supplier_orders.delete - >- it.fattureincloud.webhooks.issued_documents.self_invoices.create - >- it.fattureincloud.webhooks.issued_documents.self_invoices.update - >- it.fattureincloud.webhooks.issued_documents.self_invoices.delete - it.fattureincloud.webhooks.issued_documents.all.create - it.fattureincloud.webhooks.issued_documents.all.update - it.fattureincloud.webhooks.issued_documents.all.delete - it.fattureincloud.webhooks.received_documents.create - it.fattureincloud.webhooks.received_documents.update - it.fattureincloud.webhooks.received_documents.delete - it.fattureincloud.webhooks.receipts.create - it.fattureincloud.webhooks.receipts.update - it.fattureincloud.webhooks.receipts.delete - it.fattureincloud.webhooks.taxes.create - it.fattureincloud.webhooks.taxes.update - it.fattureincloud.webhooks.taxes.delete - it.fattureincloud.webhooks.archive_documents.create - it.fattureincloud.webhooks.archive_documents.update - it.fattureincloud.webhooks.archive_documents.delete - it.fattureincloud.webhooks.cashbook.create - it.fattureincloud.webhooks.cashbook.update - it.fattureincloud.webhooks.cashbook.delete - it.fattureincloud.webhooks.products.create - it.fattureincloud.webhooks.products.update - it.fattureincloud.webhooks.products.delete - it.fattureincloud.webhooks.products.stock_update - it.fattureincloud.webhooks.entities.clients.create - it.fattureincloud.webhooks.entities.clients.update - it.fattureincloud.webhooks.entities.clients.delete - it.fattureincloud.webhooks.entities.suppliers.create - it.fattureincloud.webhooks.entities.suppliers.update - it.fattureincloud.webhooks.entities.suppliers.delete - it.fattureincloud.webhooks.entities.all.create - it.fattureincloud.webhooks.entities.all.update - it.fattureincloud.webhooks.entities.all.delete - >- it.fattureincloud.webhooks.issued_documents.e_invoices.status_update - >- it.fattureincloud.webhooks.received_documents.e_invoices.receive config: title: WebhooksSubscriptionConfig type: object properties: mapping: title: WebhooksSubscriptionMapping type: string description: Determines the webhook payload shape enum: - binary - structured warnings: type: array nullable: true description: Webhooks registration warnings items: type: string examples: example-1: value: data: id: SUB12345 sink: http://www.test.com verified: true types: - it.fattureincloud.webhooks.entities.create - it.fattureincloud.webhooks.issued_documents.create warnings: >- The 'it.fattureincloud.webhooks.entities.clients.delete' event is already registered for this application GetCompanyPlanUsageResponse: description: Example response content: application/json: schema: title: GetCompanyPlanUsageResponse description: '' type: object properties: data: title: CompanyPlanUsage type: object properties: limit: type: number description: Plan limit nullable: true usage: type: number description: Plan usage nullable: true nullable: true examples: example-1: value: data: limit: 3000 usage: 100 security: - OAuth2AuthenticationCodeFlow: []