VendorInvoicesApi

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

Method	HTTP request	Description
create1	POST /accounting/providers/invoices	Creates a new invoice.
createPayment	POST /accounting/providers/invoices/{invoiceId}/payments	Creates a new payment on the vendor account and assigns the payment to the invoice.
delete2	DELETE /accounting/providers/invoices/{invoiceId}	Removes a provider invoice.
delete2_0	DELETE /accounting/providers/payments/{paymentId}	Removes a provider payment.
getAll2	GET /accounting/providers/invoices	Lists all vendor invoices in all statuses (including not ready and drafts) that have been updated since a specific date.
getAllIds3	GET /accounting/providers/invoices/ids	Returns vendor invoices' internal identifiers.
getById3	GET /accounting/providers/invoices/{invoiceId}	Returns provider invoice details.
getDocument1	GET /accounting/providers/invoices/{invoiceId}/document	Generates provider invoice document (PDF).
getPayments1	GET /accounting/providers/invoices/{invoiceId}/payments	Returns all payments for the vendor invoice.
send	POST /accounting/providers/invoices/{invoiceId}/send	Sends a provider invoice.
setStatus	POST /accounting/providers/invoices/{invoiceId}/status	Changes invoice status to given status.

create1

ProviderInvoiceCreateResultDTO create1(body)

Creates a new invoice.

Creates a new invoice from jobs. Jobs are grouped by provider and currency, therefore multiple invoices can be created.If any of the jobs cannot be invoiced (ie. it is already invoiced) 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.VendorInvoicesApi;

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");

VendorInvoicesApi apiInstance = new VendorInvoicesApi();
ProviderInvoiceCreateDTO body = new ProviderInvoiceCreateDTO(); // ProviderInvoiceCreateDTO | Created new invoice.
try {
    ProviderInvoiceCreateResultDTO result = apiInstance.create1(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling VendorInvoicesApi#create1");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ProviderInvoiceCreateDTO	Created new invoice.

Return type

ProviderInvoiceCreateResultDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

createPayment

createPayment(body, invoiceId)

Creates a new payment on the vendor account and assigns the payment to the 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.VendorInvoicesApi;

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");

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

Parameters

Name	Type	Description	Notes
body	PaymentDTO	New payment.
invoiceId	Long	vendor 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

delete2

delete2(invoiceId)

Removes a provider 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.VendorInvoicesApi;

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");

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

Parameters

Name	Type	Description	Notes
invoiceId	Long	provider 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

delete2_0

delete2_0(paymentId)

Removes a provider 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.VendorInvoicesApi;

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");

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

Parameters

Name	Type	Description	Notes
paymentId	Long	provider 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

getAll2

List<ProviderInvoiceDTO> getAll2(updatedSince)

Lists all vendor 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.VendorInvoicesApi;

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");

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

Parameters

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

Return type

List<ProviderInvoiceDTO>

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

getAllIds3

List<Integer> getAllIds3(updatedSince)

Returns vendor 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.VendorInvoicesApi;

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");

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

Parameters

Name	Type	Description	Notes
updatedSince	Long	only vendor 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

getById3

ProviderInvoiceDTO getById3(invoiceId)

Returns provider 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.VendorInvoicesApi;

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");

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

Parameters

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

Return type

ProviderInvoiceDTO

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

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

getDocument1

UrlResultDTO getDocument1(invoiceId)

Generates provider 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.VendorInvoicesApi;

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");

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

Parameters

Name	Type	Description	Notes
invoiceId	Long	provider 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

getPayments1

List<PaymentDTO> getPayments1(invoiceId)

Returns all payments for the vendor 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.VendorInvoicesApi;

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");

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

Parameters

Name	Type	Description	Notes
invoiceId	Long	vendor 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

send

send(invoiceId)

Sends a provider 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.VendorInvoicesApi;

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");

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

Parameters

Name	Type	Description	Notes
invoiceId	Long	provider 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

setStatus

setStatus(body, invoiceId)

Changes invoice status to given status.

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.VendorInvoicesApi;

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");

VendorInvoicesApi apiInstance = new VendorInvoicesApi();
ProviderInvoiceCreateResultDTO body = new ProviderInvoiceCreateResultDTO(); // ProviderInvoiceCreateResultDTO | Changed invoice status to given status.
Long invoiceId = 789L; // Long | provider invoice's internal identifier
try {
    apiInstance.setStatus(body, invoiceId);
} catch (ApiException e) {
    System.err.println("Exception when calling VendorInvoicesApi#setStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ProviderInvoiceCreateResultDTO	Changed invoice status to given status.
invoiceId	Long	provider invoice's internal identifier

Return type

null (empty response body)

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

Content-Type: application/json
Accept: Not defined

Files

VendorInvoicesApi.md

Latest commit

History

VendorInvoicesApi.md

File metadata and controls

VendorInvoicesApi

create1

Example

Parameters

Return type

Authorization

HTTP request headers

createPayment

Example

Parameters

Return type

Authorization

HTTP request headers

delete2

Example

Parameters

Return type

Authorization

HTTP request headers

delete2_0

Example

Parameters

Return type

Authorization

HTTP request headers

getAll2

Example

Parameters

Return type

Authorization

HTTP request headers

getAllIds3

Example

Parameters

Return type

Authorization

HTTP request headers

getById3

Example

Parameters

Return type

Authorization

HTTP request headers

getDocument1

Example

Parameters

Return type

Authorization

HTTP request headers

getPayments1

Example

Parameters

Return type

Authorization

HTTP request headers

send

Example

Parameters

Return type

Authorization

HTTP request headers

setStatus

Example

Parameters

Return type

Authorization

HTTP request headers