### GET /api/v1/Authentication Source: https://api.likvido.com Verifies the validity of the provided API key. ```APIDOC ## GET /api/v1/Authentication ### Description Use this endpoint to verify you have a valid API key. Simply make a GET to the URL below and get a response to check if you're authenticated. ### Method GET ### Endpoint /api/v1/Authentication ``` -------------------------------- ### POST /api/v1/Invoices/bulk-invoices Source: https://api.likvido.com/swagger/v1/swagger.json Performs asynchronous bulk creation of invoices. Requires pre-generated IDs (Guid). Status can be checked using various GET methods after creation. ```APIDOC ## POST /api/v1/Invoices/bulk-invoices ### Description Performs asynchronous bulk creation of invoices. Requires pre-generated IDs (Guid). Status can be checked using various GET methods after creation. ### Method POST ### Endpoint /api/v1/Invoices/bulk-invoices ### Request Body - **invoices** (array) - Required - A list of invoice objects to be created, each with a preGeneratedId. ### Request Example { "invoices": [ { "preGeneratedId": "4243bf86-f92e-431e-92f5-d61e6a270101", "invoice": { "date": "2026-01-01T00:00:00", "dueDate": "2026-01-14T00:00:00", "debtor": { "firstName": "Lars", "lastName": "Testensen", "accountingDebtorId": "5312", "email": "lars_testensen@gmail.com", "phone": "60504020", "debtorType": 0, "address": "Thujavej 60", "zipCode": "60000", "city": "Lalala", "country": "DK" }, "currency": "DKK", "campaignInitialRequest": 1, "lines": [ { "unitNetPrice": 500.0, "description": "Test", "quantity": 1.0, "vatRate": 25.0, "discountType": 0, "discountValue": 0.0 } ], "fees": [ { "netAmount": 100.0, "feeType": 1, "date": "2026-01-01T00:00:00" } ], "payments": [ { "netAmount": 250.0, "date": "2026-01-01T00:00:00", "paymentMethod": 1 } ] } } ] } ``` -------------------------------- ### GET /api/v1/Creditors/PartnerCreditors Source: https://api.likvido.com/swagger/v1/swagger.json Retrieves a list of all creditors associated with the partner that have an active API key. ```APIDOC ## GET /api/v1/Creditors/PartnerCreditors ### Description Retrieves a list of all creditors that currently have an active API key associated with the partner. (Auth roles: Partner) ### Method GET ### Endpoint /api/v1/Creditors/PartnerCreditors ### Parameters #### Query Parameters - **Take** (integer) - Optional - The number of records to return. - **Skip** (integer) - Optional - The number of records to skip. ### Responses #### Success Response (200) - **schema** (object) - The schema for the partner creditor list. #### Error Responses - **401** - Unauthorized - **403** - Forbidden ``` -------------------------------- ### GET /websites/api_likvido/invoices Source: https://api.likvido.com/swagger/v1/swagger.json Retrieves a listing of invoice records based on specified criteria. ```APIDOC ## GET /websites/api_likvido/invoices ### Description Retrieves a listing of invoice records based on specified criteria. ### Method GET ### Endpoint /websites/api_likvido/invoices ### Query Parameters - **Ids** (array of strings) - Optional - Filter invoices by their IDs (UUID format). - **CreditorIds** (array of integers) - Optional - Filter invoices by creditor IDs. - **DebtorIds** (array of integers) - Optional - Filter invoices by debtor IDs. - **CloseCodes** (array of integers) - Optional - Filter invoices by close codes. ### Response #### Success Response (200) (Response structure not detailed in the provided text, but would typically be an array of invoice objects.) #### Error Responses (Error responses for this endpoint are not detailed in the provided text.) ``` -------------------------------- ### Create Invoice Payment Source: https://api.likvido.com/swagger/v1/swagger.json Endpoint configuration for creating a payment for a specific invoice, including example request bodies for JSON and JSON-Patch formats. ```json "/api/v1/Payments/{invoiceId}": { "post": { "tags": [ "Payments" ], "summary": "Creates a payment associated with an invoice.", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatePaymentRequest" }, "example": { "invoiceId": "00000000-0000-0000-0000-000000000000", "amount": 1000.5, "closeCase": true, "communicateDebtor": false, "date": "2026-04-10T20:26:21.154173Z" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentRequest" }, "example": { "invoiceId": "00000000-0000-0000-0000-000000000000", "amount": 1000.5, "closeCase": true ``` -------------------------------- ### GET /api/v1/Creditors/{Id} Source: https://api.likvido.com/swagger/v1/swagger.json Retrieves a single creditor record by its unique identifier. ```APIDOC ## GET /api/v1/Creditors/{Id} ### Description Retrieves a single creditor record by creditor Id. ### Method GET ### Endpoint /api/v1/Creditors/{Id} ### Parameters #### Path Parameters - **Id** (integer) - Required - The unique identifier of the creditor. ### Responses #### Success Response (200) - **schema** (object) - The schema for the creditor data. #### Error Responses - **400** - Bad Request - **404** - Not Found - **401** - Unauthorized - **403** - Forbidden ``` -------------------------------- ### GET /api/v1/Invoices/{invoiceId}/files Source: https://api.likvido.com/swagger/v1/swagger.json Retrieves a listing of invoice files based on specified criteria. This endpoint allows you to fetch all files associated with a particular invoice. ```APIDOC ## GET /api/v1/Invoices/{invoiceId}/files ### Description Retrieves a listing of invoice files based on specified criteria. ### Method GET ### Endpoint /api/v1/Invoices/{invoiceId}/files #### Path Parameters - **invoiceId** (string) - Required - The unique identifier of the invoice. #### Query Parameters - **onlyOriginalInvoice** (boolean) - Optional - If true, only the original invoice file is returned. ### Response #### Success Response (200) - **ListInvoiceFilesResponse** (object) - A list of files associated with the invoice. #### Error Response - **TopLevelDocument** (object) - Represents unauthorized access or forbidden access. ``` -------------------------------- ### GET /api/v1/Debtors Source: https://api.likvido.com/swagger/v1/swagger.json Retrieves a listing of debtor records based on specified criteria. ```APIDOC ## GET /api/v1/Debtors ### Description Retrieves a listing of debtor records based on specified criteria. ### Method GET ### Endpoint /api/v1/Debtors ### Parameters #### Query Parameters - **Query** (string) - Optional - Search query string - **DebtorTypes** (array) - Optional - 0 = Private, 1 = Company - **Take** (integer) - Optional - Number of records to take - **Skip** (integer) - Optional - Number of records to skip ### Response #### Success Response (200) - **ListDebtorsResponse** (object) - A list of debtor records. ``` -------------------------------- ### GET /invoices/{id} Source: https://api.likvido.com/swagger/v1/swagger.json Retrieves detailed information about a specific invoice by its unique identifier. ```APIDOC ## GET /invoices/{id} ### Description Retrieves the full details of an invoice using its ID. ### Method GET ### Endpoint /invoices/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the invoice. ### Response #### Success Response (200) - **data** (InvoiceResourceObject) - The invoice resource object. - **errors** (array) - List of error objects if any occurred. ``` -------------------------------- ### GET /invoices/{id}/timeline Source: https://api.likvido.com/swagger/v1/swagger.json Retrieves the timeline history for a specific invoice. ```APIDOC ## GET /invoices/{id}/timeline ### Description Retrieves the timeline of events associated with a specific invoice. ### Method GET ### Endpoint /invoices/{id}/timeline ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the invoice. ### Response #### Success Response (200) - **paging** (Paging) - Paging information for the timeline items. - **data** (array) - List of TimelineItemResourceObject. - **errors** (array) - List of error objects if any occurred. ``` -------------------------------- ### GET /api/v1/Invoices/{invoiceId}/timeline Source: https://api.likvido.com/swagger/v1/swagger.json Retrieves a chronological list of activities and events associated with a specific invoice. ```APIDOC ## GET /api/v1/Invoices/{invoiceId}/timeline ### Description Retrieves timeline activities for a specific invoice. ### Method GET ### Endpoint /api/v1/Invoices/{invoiceId}/timeline ### Parameters #### Path Parameters - **invoiceId** (string) - Required - The ID of the invoice. #### Query Parameters - **fromDate** (string) - Optional - Filter activities from this date and time (ISO 8601 format). - **toDate** (string) - Optional - Filter activities up to this date and time (ISO 8601 format). - **eventTypes** (string) - Optional - Filter activities by specific event types. - **page** (integer) - Optional - The page number for pagination. Defaults to 1. - **pageSize** (integer) - Optional - The number of items per page. Defaults to 25. - **sort** (string) - Optional - The sorting order for the timeline. Defaults to "timestamp_desc". ### Responses #### Success Response (200) OK #### Error Responses - **400** Bad Request - **403** Forbidden ``` -------------------------------- ### GET /api/v1/Invoices/{id} Source: https://api.likvido.com/swagger/v1/swagger.json Retrieves a single invoice record by its unique identifier. ```APIDOC ## GET /api/v1/Invoices/{id} ### Description Retrieves a single invoice record by invoice Id. ### Method GET ### Endpoint /api/v1/Invoices/{id} ### Parameters #### Path Parameters - **id** (string, uuid) - Required - The unique identifier of the invoice. ``` -------------------------------- ### POST /api/v1/Creditors Source: https://api.likvido.com Creates a new creditor record. Requires Partner role. ```APIDOC ## POST /api/v1/Creditors ### Description Creates a new creditor record. (Auth roles: Partner) ### Method POST ### Endpoint /api/v1/Creditors ``` -------------------------------- ### POST /websites/api_likvido/invoices Source: https://api.likvido.com/swagger/v1/swagger.json Creates a new invoice with detailed line items, fees, and payment information. ```APIDOC ## POST /websites/api_likvido/invoices ### Description Creates a new invoice with detailed line items, fees, and payment information. ### Method POST ### Endpoint /websites/api_likvido/invoices ### Request Body - **date** (string) - Required - The date of the invoice. - **dueDate** (string) - Required - The due date of the invoice. - **debtor** (object) - Required - Information about the debtor. - **firstName** (string) - Required - The first name of the debtor. - **lastName** (string) - Required - The last name of the debtor. - **accountingDebtorId** (string) - Optional - The accounting ID of the debtor. - **email** (string) - Optional - The email address of the debtor. - **phone** (string) - Optional - The phone number of the debtor. - **debtorType** (integer) - Optional - The type of debtor (e.g., 0 for Person, 1 for Company). - **address** (string) - Optional - The address of the debtor. - **zipCode** (string) - Optional - The zip code of the debtor. - **city** (string) - Optional - The city of the debtor. - **accountingDebtorGroupId** (string) - Optional - The accounting group ID of the debtor. - **country** (string) - Optional - The country code of the debtor. - **currency** (string) - Required - The currency of the invoice (e.g., "DKK"). - **campaignInitialRequest** (integer) - Optional - Indicates if this is an initial campaign request. - **lines** (array) - Required - An array of invoice line items. - **unitNetPrice** (number) - Required - The net price per unit. - **description** (string) - Required - The description of the line item. - **quantity** (number) - Required - The quantity of the item. - **vatRate** (number) - Required - The VAT rate applied. - **discountType** (integer) - Optional - The type of discount. - **discountValue** (number) - Optional - The value of the discount. - **fees** (array) - Optional - An array of fees associated with the invoice. - **netAmount** (number) - Required - The net amount of the fee. - **feeType** (integer) - Required - The type of fee. - **date** (string) - Required - The date the fee is applied. - **payments** (array) - Optional - An array of payments made towards the invoice. - **netAmount** (number) - Required - The net amount of the payment. - **date** (string) - Required - The date of the payment. - **paymentMethod** (integer) - Required - The method of payment. ### Request Example ```json { "date": "2026-01-01T00:00:00", "dueDate": "2026-01-14T00:00:00", "debtor": { "firstName": "Lars", "lastName": "Testensen", "accountingDebtorId": "5312", "email": "lars_testensen@gmail.com", "phone": "60504020", "debtorType": 0, "address": "Thujavej 60", "zipCode": "60000", "city": "Lalala", "accountingDebtorGroupId": "test-group-99", "country": "DK" }, "currency": "DKK", "campaignInitialRequest": 1, "lines": [ { "unitNetPrice": 500.0, "description": "Test", "quantity": 1.0, "vatRate": 25.0, "discountType": 0, "discountValue": 0.0 } ], "fees": [ { "netAmount": 100.0, "feeType": 1, "date": "2026-01-01T00:00:00" } ], "payments": [ { "netAmount": 250.0, "date": "2026-01-01T00:00:00", "paymentMethod": 1 } ] } ``` ### Response #### Success Response (201) - **location** (string) - Location of the newly created invoice. #### Response Example (No specific response body example provided, but it would typically contain details of the created invoice or a confirmation.) #### Error Responses - **400** Bad Request: Indicates an issue with the request payload. - **401** Unauthorized: Authentication is required or has failed. - **403** Forbidden: The authenticated user does not have permission to perform this action. ``` -------------------------------- ### GET /api/v1/Debtors/{id} Source: https://api.likvido.com/swagger/v1/swagger.json Retrieves a single debtor record by debtor Id. ```APIDOC ## GET /api/v1/Debtors/{id} ### Description Retrieves a single debtor record by debtor Id. ### Method GET ### Endpoint /api/v1/Debtors/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The unique identifier of the debtor ### Response #### Success Response (200) - **GetDebtorByIdResponse** (object) - The debtor record details. ``` -------------------------------- ### POST /api/v1/Invoices Source: https://api.likvido.com/swagger/v1/swagger.json Creates a new invoice record in the system. This endpoint allows for detailed invoice creation including debtor information, lines, fees, and payments. ```APIDOC ## POST /api/v1/Invoices ### Description Creates a new invoice record. ### Method POST ### Endpoint /api/v1/Invoices ### Parameters #### Request Body - **date** (string) - Required - The date of the invoice. - **dueDate** (string) - Required - The due date for the invoice. - **debtor** (object) - Required - Information about the debtor. - **firstName** (string) - Required - The first name of the debtor. - **lastName** (string) - Required - The last name of the debtor. - **accountingDebtorId** (string) - Required - The accounting ID of the debtor. - **email** (string) - Optional - The email address of the debtor. - **phone** (string) - Optional - The phone number of the debtor. - **debtorType** (integer) - Required - The type of debtor (e.g., 0 for person, 1 for company). - **address** (string) - Required - The street address of the debtor. - **zipCode** (string) - Required - The zip code of the debtor. - **city** (string) - Required - The city of the debtor. - **accountingDebtorGroupId** (string) - Optional - The accounting group ID for the debtor. - **country** (string) - Required - The country code of the debtor (e.g., "DK"). - **currency** (string) - Required - The currency of the invoice (e.g., "DKK"). - **campaignInitialRequest** (integer) - Optional - Indicates if this is an initial request for a campaign. - **lines** (array) - Required - An array of invoice line items. - **unitNetPrice** (number) - Required - The net price per unit. - **description** (string) - Required - A description of the line item. - **quantity** (number) - Required - The quantity of the item. - **vatRate** (number) - Required - The VAT rate applied. - **discountType** (integer) - Optional - The type of discount. - **discountValue** (number) - Optional - The value of the discount. - **fees** (array) - Optional - An array of fees associated with the invoice. - **netAmount** (number) - Required - The net amount of the fee. - **feeType** (integer) - Required - The type of fee. - **date** (string) - Required - The date the fee is applied. - **payments** (array) - Optional - An array of payments made towards the invoice. - **netAmount** (number) - Required - The net amount of the payment. - **date** (string) - Required - The date of the payment. - **paymentMethod** (integer) - Required - The method of payment. ### Request Example ```json { "date": "2026-01-01T00:00:00", "dueDate": "2026-01-14T00:00:00", "debtor": { "firstName": "Lars", "lastName": "Testensen", "accountingDebtorId": "5312", "email": "lars_testensen@gmail.com", "phone": "60504020", "debtorType": 0, "address": "Thujavej 60", "zipCode": "60000", "city": "Lalala", "accountingDebtorGroupId": "test-group-99", "country": "DK" }, "currency": "DKK", "campaignInitialRequest": 1, "lines": [ { "unitNetPrice": 500.0, "description": "Test", "quantity": 1.0, "vatRate": 25.0, "discountType": 0, "discountValue": 0.0 } ], "fees": [ { "netAmount": 100.0, "feeType": 1, "date": "2026-01-01T00:00:00" } ], "payments": [ { "netAmount": 250.0, "date": "2026-01-01T00:00:00", "paymentMethod": 1 } ] } ``` ### Response #### Success Response (200) - **invoiceId** (string) - The ID of the created invoice. - **status** (string) - The status of the invoice. #### Response Example ```json { "invoiceId": "inv_12345", "status": "Created" } ``` ``` -------------------------------- ### Create Debtor Schema Source: https://api.likvido.com/swagger/v1/swagger.json Defines the request and response structures for creating a new debtor in the system. ```APIDOC ### CreateDebtorRequest ### Request Body - **debtorType** (LegalEntityType) - Type of the debtor - **companyName** (string) - Name of the company - **companyRegistrationNumber** (string) - Registration number - **eanNumber** (string) - EAN number - **firstName** (string) - First name - **lastName** (string) - Last name - **personRegistrationNumber** (string) - Personal registration number - **accountingDebtorId** (string) - ID in accounting system - **accountingDebtorGroupId** (string) - Group ID in accounting system - **personBirthDay** (date-time) - Birth date - **email** (string) - Email address - **phone** (string) - Phone number - **address** (string) - Address line 1 - **addressTwo** (string) - Address line 2 - **zipCode** (string) - Zip code - **city** (string) - City - **state** (string) - State - **country** (string) - Country Alpha2 code (default 'DK') ``` -------------------------------- ### Create Payment API Source: https://api.likvido.com/swagger/v1/swagger.json This endpoint allows you to record a payment against an invoice. You can specify the amount, date, and whether to close the case. ```APIDOC ## POST /websites/api_likvido/payments ### Description Records a payment for a specific invoice. ### Method POST ### Endpoint /websites/api_likvido/payments ### Request Body - **invoiceId** (string) - Required - The ID of the invoice to which the payment is applied. - **amount** (number) - Required - The amount of the payment. - **closeCase** (boolean) - Optional - Whether to close the invoice case after this payment. - **communicateDebtor** (boolean) - Optional - Whether to communicate the payment to the debtor. - **date** (string) - Required - The date the payment was made (ISO 8601 format). ### Request Example ```json { "invoiceId": "inv_12345", "amount": 125.00, "date": "2023-10-27T12:00:00Z", "closeCase": true } ``` ### Response #### Success Response (200) - **status** (integer) - The status code of the operation. - **message** (string) - A message indicating the result of the operation. #### Response Example ```json { "status": 200, "message": "Payment recorded successfully." } ``` ``` -------------------------------- ### Create Creditor API Source: https://api.likvido.com/swagger/v1/swagger.json This endpoint allows for the creation of a new creditor. It requires detailed information about the company, including its address, contact information, and financial details. ```APIDOC ## POST /api/creditors ### Description Creates a new creditor with the provided company details. ### Method POST ### Endpoint /api/creditors ### Parameters #### Request Body - **companyName** (string) - Required - Name of the company we're creating - **companyRegistrationNumber** (string) - Required - This is the official company registration number (VAT/CVR register) - **address** (string) - Required - The address where the company has their main office - **zipCode** (string) - Required - The zipcode where the company has their main office - **city** (string) - Required - The city where the company has their main office - **officeEmail** (string) - Required - The contact e-mail of the business - **sendWelcomeMail** (boolean) - Optional - Whether to send a welcome email - **companyType** (integer) - Optional - The type of company - **country** (string) - Optional - The country of the company - **termsAcceptedLabel** (string) - Optional - Label for terms acceptance - **nickname** (string) - Optional - Shorter name of the company - **shortNickName** (string) - Optional - Max 11 char long name of the company (used for SMS and more) - **officePhone** (string) - Optional - The contact phone number of the business - **exemptFromVat** (boolean) - Optional - Used if the company is exempt from VAT - **registrationNumber** (string) - Optional - The bank accounts registration number (pattern: [0-9]{4}) - **bankAccountNumber** (string) - Optional - Bank account number (pattern: [0-9]{6,10}) - **ibanCode** (string) - Optional - IBAN code - **swiftCode** (string) - Optional - SWIFT code - **bankName** (string) - Optional - Name of the bank - **currencyCode** (string) - Optional - Bank account currency code (pattern: [a-zA-Z]{3}). Defaults to DKK if country is not specified. - **accountSystemType** (AccountSystemType) - Optional - Type of account system - **token** (string) - Optional - Authentication token - **settings_InvoiceEnabled** (boolean) - Optional - Enable invoice settings - **settings_RemindersEnabled** (boolean) - Optional - Enable reminder settings - **settings_DebtCollectionEnabled** (boolean) - Optional - Enable debt collection settings - **settings_AutoStartDebtCollection** (boolean) - Optional - Automatically start debt collection - **settings_AutoStartReminders** (boolean) - Optional - Automatically start reminders - **settings_AcceptCreditCard** (boolean) - Optional - Accept credit card payments ### Request Example ```json { "companyName": "Example Corp", "companyRegistrationNumber": "12345678", "address": "123 Main St", "zipCode": "1000", "city": "Copenhagen", "officeEmail": "info@example.com", "sendWelcomeMail": true, "currencyCode": "DKK" } ``` ### Response #### Success Response (200) - **id** (string) - The unique identifier of the created creditor. #### Response Example ```json { "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef" } ``` ``` -------------------------------- ### Create Invoice API Source: https://api.likvido.com/swagger/v1/swagger.json This endpoint allows you to create a new invoice. It accepts detailed information about the invoice, including debtor, items, fees, and payments. ```APIDOC ## POST /websites/api_likvido/invoices ### Description Creates a new invoice with specified details. ### Method POST ### Endpoint /websites/api_likvido/invoices ### Request Body - **debtor** (object) - Required - Information about the debtor. - **name** (string) - Required - The name of the debtor. - **address** (string) - Optional - The address of the debtor. - **zipCode** (string) - Optional - The zip code of the debtor. - **city** (string) - Optional - The city of the debtor. - **country** (string) - Optional - The country of the debtor. - **vatNumber** (string) - Optional - The VAT number of the debtor. - **email** (string) - Optional - The email address of the debtor. - **phone** (string) - Optional - The phone number of the debtor. - **items** (array) - Optional - An array of invoice items. - **description** (string) - Required - Description of the item. - **quantity** (number) - Required - Quantity of the item. - **unitPrice** (number) - Required - Price per unit. - **vatRate** (number) - Optional - VAT rate for the item. - **fees** (array) - Optional - An array of invoice fees. - **payments** (array) - Optional - An array of invoice payments. ### Request Example ```json { "debtor": { "name": "Example Corp", "email": "contact@example.com" }, "items": [ { "description": "Service Fee", "quantity": 1, "unitPrice": 100, "vatRate": 25 } ] } ``` ### Response #### Success Response (200) - **data** (object) - Contains the created invoice resource. - **id** (string) - The unique identifier for the invoice. - **type** (string) - The type of resource, typically "invoices". - **attributes** (object) - The attributes of the invoice. - **invoiceNumber** (string) - The invoice number. - **issueDate** (string) - The date the invoice was issued. - **dueDate** (string) - The due date for the invoice. - **totalAmount** (number) - The total amount of the invoice. - **currency** (string) - The currency of the invoice. - **status** (string) - The current status of the invoice. - **debtor** (object) - Information about the debtor. - **items** (array) - Array of invoice items. - **fees** (array) - Array of invoice fees. - **payments** (array) - Array of invoice payments. - **errors** (array) - An array of error objects, if any occurred. #### Response Example ```json { "data": { "id": "inv_12345", "type": "invoices", "attributes": { "invoiceNumber": "INV-2023-001", "issueDate": "2023-10-27T10:00:00Z", "dueDate": "2023-11-26T10:00:00Z", "totalAmount": 125.00, "currency": "EUR", "status": "draft", "debtor": { "name": "Example Corp", "email": "contact@example.com" }, "items": [ { "description": "Service Fee", "quantity": 1, "unitPrice": 100, "vatRate": 25 } ], "fees": [], "payments": [] } }, "errors": null } ``` ``` -------------------------------- ### Create Creditor Schema Source: https://api.likvido.com/swagger/v1/swagger.json Defines the structure for the CreateCreditorResponse, including metadata and creditor resource objects. ```APIDOC ### CreateCreditorResponse ### Response - **meta** (CreateCreditorResponseMeta) - Metadata containing partnerApiKey - **data** (CreditorResourceObject) - The created creditor resource - **errors** (array) - List of ErrorObject if any occurred ``` -------------------------------- ### GET /api/v1/Invoices/{invoiceId}/transferred-payments Source: https://api.likvido.com/swagger/v1/swagger.json Retrieves a listing of transferred invoice payments for a specific invoice Id, excluding credit notes. ```APIDOC ## GET /api/v1/Invoices/{invoiceId}/transferred-payments ### Description Retrieves a listing of transferred invoice payments for a specific invoice Id. Returns only payments that have been transferred (paid out) to the creditor. ### Method GET ### Endpoint /api/v1/Invoices/{invoiceId}/transferred-payments ### Parameters #### Path Parameters - **invoiceId** (string, uuid) - Required - The unique identifier of the invoice. #### Query Parameters - **Take** (integer) - Optional - Number of records to take. - **Skip** (integer) - Optional - Number of records to skip. ``` -------------------------------- ### POST /api/v1/Invoices Source: https://api.likvido.com Creates a new invoice record. ```APIDOC ## POST /api/v1/Invoices ### Description Creates a new invoice record. ### Method POST ### Endpoint /api/v1/Invoices ``` -------------------------------- ### Create Bulk Invoices API Source: https://api.likvido.com/swagger/v1/swagger.json This endpoint allows for the creation of multiple invoices in a single request. It uses the CreateBulkInvoicesRequest schema for the request body. ```APIDOC ## POST /api/invoices/bulk ### Description Creates multiple invoices in a single request. ### Method POST ### Endpoint /api/invoices/bulk ### Parameters #### Request Body - **invoices** (array) - Optional - An array of invoice objects to create. - Each item in the array should conform to the CreateBulkInvoiceRequestItem schema. ### Request Example ```json { "invoices": [ { "creditorId": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "debtorId": "b2c3d4e5-f6a7-8901-2345-67890abcdef1", "amount": 100.50, "currencyCode": "DKK", "dueDate": "2023-12-31" }, { "creditorId": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "debtorId": "c3d4e5f6-a7b8-9012-3456-7890abcdef12", "amount": 250.00, "currencyCode": "EUR", "dueDate": "2024-01-15" } ] } ``` ### Response #### Success Response (200) - **invoiceIds** (array) - A list of unique identifiers for the created invoices. #### Response Example ```json { "invoiceIds": [ "c3d4e5f6-a7b8-9012-3456-7890abcdef12", "d4e5f6a7-b8c9-0123-4567-890abcdef123" ] } ``` ``` -------------------------------- ### POST /debtors Source: https://api.likvido.com/swagger/v1/swagger.json Creates a new debtor in the system. DebtorType can be set to 0 for Private or 1 for Company. ```APIDOC ## POST /debtors ### Description Creates a new Debtor. (DebtorType: Private = 0 , Company = 1) ### Method POST ### Endpoint /debtors ### Request Body - **debtorType** (integer) - Required - 0 for Private, 1 for Company - **companyName** (string) - Optional - **firstName** (string) - Optional - **lastName** (string) - Optional - **accountingDebtorId** (string) - Optional - **accountingDebtorGroupId** (string) - Optional - **email** (string) - Optional - **phone** (string) - Optional - **address** (string) - Optional - **zipCode** (string) - Optional - **city** (string) - Optional - **country** (string) - Optional ### Request Example { "debtorType": 0, "companyName": "", "firstName": "Lars", "lastName": "Testensen", "accountingDebtorId": "5312", "accountingDebtorGroupId": "test-group-99", "email": "lars_testensen@gmail.com", "phone": "60504020", "address": "Thujavej 60", "zipCode": "60000", "city": "Lalala", "country": "DK" } ### Response #### Success Response (200) - **CreateDebtorResponse** (object) - The created debtor details. #### Error Response (400) - **errors** (array) - List of validation errors. #### Response Example { "errors": [ { "status": 400, "code": "NotEmptyValidator", "title": "Company name is required" } ] } ``` -------------------------------- ### GET /api/v1/Invoices/{invoiceId}/payments Source: https://api.likvido.com/swagger/v1/swagger.json Returns ALL payments associated with an invoice, including credit notes and payments that have not been transferred. This endpoint provides comprehensive payment reconciliation, including pending payments and credit notes. ```APIDOC ## GET /api/v1/Invoices/{invoiceId}/payments ### Description Returns ALL payments associated with an invoice, including credit notes and payments that have not been transferred. **Payment Information:** Each payment includes: - Basic payment details (amount, method, date, etc.) - Transfer status and details (if applicable) - Currency information for multi-currency payments - Payment provider information **Transfer Details:** The `transfer` property indicates whether a payment has been transferred (paid out) to the creditor: - `hasTransfer = true`: Payment has been transferred, transfer details are included - `hasTransfer = false`: Payment exists but has not been transferred (e.g., credit notes, pending payments) **Use Cases:** - Complete payment reconciliation including credit notes - Identifying payments awaiting transfer - Understanding the full payment history of an invoice **Related Endpoint:** For only transferred payments (excluding credit notes and pending), use `/api/v1/Invoices/{invoiceId}/transferred-payments` ### Method GET ### Endpoint /api/v1/Invoices/{invoiceId}/payments #### Path Parameters - **invoiceId** (string) - Required - The unique identifier of the invoice. #### Query Parameters - **Take** (integer) - Optional - The maximum number of records to return. - **Skip** (integer) - Optional - The number of records to skip from the beginning. ### Response #### Success Response (200) - **ListInvoicePaymentsResponse** (object) - A list of payments associated with the invoice. #### Error Response - **TopLevelDocument** (object) - Represents a bad request, unauthorized access, or forbidden access. ``` -------------------------------- ### Invoice File Resource Schema Source: https://api.likvido.com/swagger/v1/swagger.json Defines the structure for invoice file resources, including attributes like file name, ID, and creation date. ```APIDOC ## InvoiceFileResourceObject ### Description Represents an invoice file resource containing metadata and file attributes. ### Request Body - **type** (string) - ReadOnly - The resource type. - **attributes** (InvoiceFileAttributes) - Required - The file metadata. - **id** (string/uuid) - Required - The unique identifier for the file resource. ### InvoiceFileAttributes - **fileName** (string) - Optional - The name of the file. - **invoiceId** (string/uuid) - Required - The ID of the associated invoice. - **fileType** (FileType) - Required - The type of file. - **entityType** (EntityType) - Required - The type of entity. - **entityValueId** (string/uuid) - Optional - The ID of the entity value. - **url** (string) - Optional - The download URL for the file. - **dateCreated** (string/date-time) - Required - The timestamp when the file was created. ``` -------------------------------- ### Creditor Resource Object Source: https://api.likvido.com/swagger/v1/swagger.json Represents a complete creditor resource. ```APIDOC ## Creditor Resource Object Schema ### Description This schema defines the structure for a complete creditor resource object. ### Properties - **type** (string) - Nullable - ReadOnly - The type of the resource. - **attributes** (CreditorAttributes) - The attributes of the creditor. - **id** (integer) - The unique identifier for the creditor. ``` -------------------------------- ### CreateInvoicePaymentRequest Schema Source: https://api.likvido.com/swagger/v1/swagger.json Defines the structure for recording a payment against an invoice. ```APIDOC ## CreateInvoicePaymentRequest ### Request Body - **netAmount** (number) - Required - The net amount paid. - **date** (string, date-time) - Optional - Date of the payment. - **paymentMethod** (PaymentMethod) - Optional - Method used for payment. ``` -------------------------------- ### POST /api/v1/Debtors Source: https://api.likvido.com Creates a new debtor record. ```APIDOC ## POST /api/v1/Debtors ### Description Creates a new Debtor. (DebtorType: Private = 0 , Company = 1) ### Method POST ### Endpoint /api/v1/Debtors ``` -------------------------------- ### CreateInvoiceRequest Schema Source: https://api.likvido.com/swagger/v1/swagger.json Defines the structure for creating a new invoice, including dates, debtor information, and invoice lines. ```APIDOC ## CreateInvoiceRequest ### Request Body - **date** (string, date-time) - Required - The date of the invoice. - **dueDate** (string, date-time) - Required - The due date of the invoice. - **debtor** (CreateInvoiceDebtorRequest) - Optional - Debtor details. - **debtorId** (integer) - Optional - ID of an existing debtor. - **referenceId** (string) - Optional - External reference ID. - **creditorReference** (string) - Optional - Reference for the creditor. - **comments** (string) - Optional - General comments. - **currency** (string) - Optional - Currency code. - **creditorComment** (string) - Optional - Internal creditor comment. - **campaignInitialRequest** (CampaignType) - Optional - Campaign type associated with the invoice. - **lines** (array) - Optional - List of invoice lines. ``` -------------------------------- ### Data Schemas and Definitions Source: https://api.likvido.com/swagger/v1/swagger.json Definitions for core data structures including Debtor objects, Entity types, and Error handling objects. ```APIDOC ## Data Schemas ### DebtorResourceObject - **id** (integer) - Unique identifier for the debtor. - **type** (string) - Resource type. - **attributes** (DebtorAttributes) - Object containing debtor details like EAN number, birthday, and country ID. ### EntityType - **Description**: Enum representing various system entities. - **Values**: - 0: Invoice - 1: Objection - 2: Enforcement - 4: Payout - 5: Debtor - 6: BankAccountEntry - 7: InvoiceStartup - 8: Bill - 9: BankEntry - 10: DebtorReminderCampaign ### ErrorObject - **status** (integer) - HTTP status code. - **code** (string) - Internal error code. - **title** (string) - Error description. ``` -------------------------------- ### Invoice and Payment Response Schemas Source: https://api.likvido.com/swagger/v1/swagger.json Definitions for list responses related to invoices, files, and payments. ```APIDOC ## ListInvoicesResponse ### Description Response object containing a list of invoices and pagination metadata. ### Response - **paging** (Paging) - Pagination details - **data** (array) - List of InvoiceResourceObject - **errors** (array) - List of ErrorObject ## ListInvoicePaymentsResponse ### Description Response object containing a list of invoice payments. ### Response - **paging** (Paging) - Pagination details - **data** (array) - List of PaymentResourceObject - **errors** (array) - List of ErrorObject ```