Skip to content

Latest commit

 

History

History
903 lines (660 loc) · 29.2 KB

ClientInvoicesApi.md

File metadata and controls

903 lines (660 loc) · 29.2 KB

ClientInvoicesApi

All URIs are relative to https://hornet-trunk.dev.xtrf.eu/home-api

Method HTTP request Description
create POST /accounting/customers/invoices Creates a new invoice.
createPayment POST /accounting/customers/invoices/{invoiceId}/payments Adds a new payment to the client invoice. The invoice payment status (Not Paid, Partially Paid, Fully Paid) is automatically recalculated.
delete DELETE /accounting/customers/invoices/{invoiceId} Removes a client invoice.
delete_0 DELETE /accounting/customers/payments/{paymentId} Removes a customer payment.
downloadDocuments POST /accounting/customers/invoices/documents Generates client invoices' documents.
duplicate POST /accounting/customers/invoices/{invoiceId}/duplicate Duplicate client invoice.
duplicateAsProForma POST /accounting/customers/invoices/{invoiceId}/duplicate/proForma Duplicate client invoice as pro forma.
getAll GET /accounting/customers/invoices Lists all client invoices in all statuses (including not ready and drafts) that have been updated since a specific date.
getAllIds GET /accounting/customers/invoices/ids Returns client invoices' internal identifiers.
getById GET /accounting/customers/invoices/{invoiceId} Returns client invoice details.
getDates GET /accounting/customers/invoices/{invoiceId}/dates Returns dates of a given client invoice.
getDocument GET /accounting/customers/invoices/{invoiceId}/document Generates client invoice document (PDF).
getPaymentTerms GET /accounting/customers/invoices/{invoiceId}/paymentTerms Returns payment terms of a given client invoice.
getPayments GET /accounting/customers/invoices/{invoiceId}/payments Returns all payments for the client invoice.
sendReminder POST /accounting/customers/invoices/{invoiceId}/sendReminder Sends reminder.
sendReminders POST /accounting/customers/invoices/sendReminders Sends reminders. Returns number of sent e-mails.

create

CustomerInvoiceCreateResultDTO create(body)

Creates a new invoice.

Creates a new invoice from tasks. Tasks are grouped by client and currency, therefore multiple invoices can be created.If any of the tasks cannot be invoiced (ie. it is already invoiced, not invoiceable, not associated with a project) then an error is reported.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
CustomerInvoiceCreateDTO body = new CustomerInvoiceCreateDTO(); // CustomerInvoiceCreateDTO | Created new invoice.
try {
    CustomerInvoiceCreateResultDTO result = apiInstance.create(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#create");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body CustomerInvoiceCreateDTO Created new invoice.

Return type

CustomerInvoiceCreateResultDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: application/json;charset=UTF-8
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

createPayment

createPayment(body, invoiceId)

Adds a new payment to the client invoice. The invoice payment status (Not Paid, Partially Paid, Fully Paid) is automatically recalculated.

Adds a new payment to the client invoice. The invoice payment status (Not Paid, Partially Paid, Fully Paid) is automatically recalculated.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
PaymentDTO body = new PaymentDTO(); // PaymentDTO | New payment.
Long invoiceId = 789L; // Long | client invoice's internal identifier
try {
    apiInstance.createPayment(body, invoiceId);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#createPayment");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body PaymentDTO New payment.
invoiceId Long client invoice's internal identifier

Return type

null (empty response body)

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: application/json;charset=UTF-8
  • Accept: Not defined

delete

delete(invoiceId)

Removes a client invoice.

Removes a client invoice.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
Long invoiceId = 789L; // Long | client invoice's internal identifier
try {
    apiInstance.delete(invoiceId);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#delete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
invoiceId Long client invoice's internal identifier

Return type

null (empty response body)

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

delete_0

delete_0(paymentId)

Removes a customer payment.

Removes a customer payment.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
Long paymentId = 789L; // Long | customer payment's internal identifier
try {
    apiInstance.delete_0(paymentId);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#delete_0");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
paymentId Long customer payment's internal identifier

Return type

null (empty response body)

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

downloadDocuments

UrlResultDTO downloadDocuments(body)

Generates client invoices' documents.

Generates client invoices' documents.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
DownloadDocumentsRequestDTO body = new DownloadDocumentsRequestDTO(); // DownloadDocumentsRequestDTO | Generated client invoices documents.
try {
    UrlResultDTO result = apiInstance.downloadDocuments(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#downloadDocuments");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body DownloadDocumentsRequestDTO Generated client invoices documents.

Return type

UrlResultDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: application/json;charset=UTF-8
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

duplicate

CustomerInvoiceDTO duplicate(invoiceId)

Duplicate client invoice.

Duplicate client invoice.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
Long invoiceId = 789L; // Long | client invoice's internal identifier
try {
    CustomerInvoiceDTO result = apiInstance.duplicate(invoiceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#duplicate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
invoiceId Long client invoice's internal identifier

Return type

CustomerInvoiceDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

duplicateAsProForma

CustomerInvoiceDTO duplicateAsProForma(invoiceId)

Duplicate client invoice as pro forma.

Duplicate client invoice as pro forma.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
Long invoiceId = 789L; // Long | client invoice's internal identifier
try {
    CustomerInvoiceDTO result = apiInstance.duplicateAsProForma(invoiceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#duplicateAsProForma");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
invoiceId Long client invoice's internal identifier

Return type

CustomerInvoiceDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getAll

List<CustomerInvoiceDTO> getAll(updatedSince)

Lists all client invoices in all statuses (including not ready and drafts) that have been updated since a specific date.

Lists all client invoices in all statuses (including not ready and drafts) that have been updated since a specific date.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
Long updatedSince = 789L; // Long | only client invoices modified since this timestamp
try {
    List<CustomerInvoiceDTO> result = apiInstance.getAll(updatedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#getAll");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
updatedSince Long only client invoices modified since this timestamp [optional]

Return type

List<CustomerInvoiceDTO>

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getAllIds

List<Integer> getAllIds(updatedSince)

Returns client invoices' internal identifiers.

Returns client invoices' internal identifiers.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
Long updatedSince = 789L; // Long | only client invoices modified since this timestamp
try {
    List<Integer> result = apiInstance.getAllIds(updatedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#getAllIds");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
updatedSince Long only client invoices modified since this timestamp [optional]

Return type

List<Integer>

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getById

CustomerInvoiceDTO getById(invoiceId, embed)

Returns client invoice details.

Returns client invoice details.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
Long invoiceId = 789L; // Long | client invoice's internal identifier
String embed = "embed_example"; // String | list of adittional fields which should be embedded in the response (ie. tasks)
try {
    CustomerInvoiceDTO result = apiInstance.getById(invoiceId, embed);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#getById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
invoiceId Long client invoice's internal identifier
embed String list of adittional fields which should be embedded in the response (ie. tasks) [optional]

Return type

CustomerInvoiceDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getDates

CustomerInvoiceDatesDTO getDates(invoiceId)

Returns dates of a given client invoice.

Returns dates of a given client invoice.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
Long invoiceId = 789L; // Long | client invoice's internal identifier
try {
    CustomerInvoiceDatesDTO result = apiInstance.getDates(invoiceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#getDates");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
invoiceId Long client invoice's internal identifier

Return type

CustomerInvoiceDatesDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getDocument

UrlResultDTO getDocument(invoiceId)

Generates client invoice document (PDF).

Generates client invoice document (PDF).

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
Long invoiceId = 789L; // Long | client invoice's internal identifier
try {
    UrlResultDTO result = apiInstance.getDocument(invoiceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#getDocument");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
invoiceId Long client invoice's internal identifier

Return type

UrlResultDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getPaymentTerms

PaymentTermsDTO getPaymentTerms(invoiceId)

Returns payment terms of a given client invoice.

Returns payment terms of a given client invoice.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
Long invoiceId = 789L; // Long | client invoice's internal identifier
try {
    PaymentTermsDTO result = apiInstance.getPaymentTerms(invoiceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#getPaymentTerms");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
invoiceId Long client invoice's internal identifier

Return type

PaymentTermsDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getPayments

List<PaymentDTO> getPayments(invoiceId)

Returns all payments for the client invoice.

Returns all payments for the client invoice.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
Long invoiceId = 789L; // Long | client invoice's internal identifier
try {
    List<PaymentDTO> result = apiInstance.getPayments(invoiceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#getPayments");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
invoiceId Long client invoice's internal identifier

Return type

List<PaymentDTO>

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

sendReminder

sendReminder(invoiceId)

Sends reminder.

Sends reminder.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
Long invoiceId = 789L; // Long | client invoice's internal identifier
try {
    apiInstance.sendReminder(invoiceId);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#sendReminder");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
invoiceId Long client invoice's internal identifier

Return type

null (empty response body)

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

sendReminders

SendRemindersResponseDTO sendReminders(body)

Sends reminders. Returns number of sent e-mails.

Sends reminders. Returns number of sent e-mails.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ClientInvoicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

ClientInvoicesApi apiInstance = new ClientInvoicesApi();
SendRemindersRequestDTO body = new SendRemindersRequestDTO(); // SendRemindersRequestDTO | Number of sent e-mails.
try {
    SendRemindersResponseDTO result = apiInstance.sendReminders(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientInvoicesApi#sendReminders");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body SendRemindersRequestDTO Number of sent e-mails.

Return type

SendRemindersResponseDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: application/json;charset=UTF-8
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8