Top-Up API
1. Introduction
The HORISEN Top-up API is used to build software that handles Top-Up Credit for a Prepaid SMS Account in Messaging Platform and related invoice creation and payment clearance.
The subject domain of an endpoint URL is:
https://api.horisen.pro/bulk/billing/v2
The API uses the HORISEN implementation of the OAuth 2.0 protocol. For more information, refer to the OAuth2 Authentication Guidelines page.
2. Methods Overview
2.1 Invoices
Endpoints for working with invoices.
2.2 Invoice Clearing
Endpoints for working with invoice clearing.
2.3 Payment Type
Endpoint for working with Payment Type.
2.4 Total Balances
Endpoints for working with Total Balances.
2.5 Credit Records
Endpoints for working with Credit Records.
3. Methods Details
3.1 Invoices
Endpoints for working with invoices.
Method Overview
The method returns a list of payable Invoices.
Authorization privilege needed for this endpoint: finance-invoices.view.
Optional privilege used in this endpoint: finance-invoices-own.view.
URL Parameters
Name | Type | Description |
---|---|---|
operator(fieldName) | string (query) | Search criteria. |
q | string (query) | General search criteria. The available fields are: custShortName, custName, invNumber, invDate, invoicingDate, invoicingDatePolicy, invDueDate, invTypeName, invPeriod, disputeStatus, ownerId, ownerBpName, ownerBpBriefName. |
page_size | integer (query) | Page size. The default value is 10. |
page_number | integer (query) | Page number. The default value is 1. . |
paging | string (query) | Paging options. The format is: &paging=page_num,page_size e.g. paging=1,10. |
sort | string (query) | Sort available fields: custName, custShortName, invNumber, invDate, invDueDate, overDueDate, total, totalUnpaid, totalPaid, invType, invTypeName, invPeriod, invPeriodStart, invPeriodEnd, invoicingDate, invoicingDatePolicy, classCodeName, currency, id, disputeStatus, statusDt, dataSourceCodeName, custID, processingStatus, collectionLeadId, collectionMode, vat, amountNoVat, amountVat, domainCodeName, custCountry, nettingInvoiceStatus, nettingInvoicePaymentStatus, rounding, dtsSelectorId, dtsSelectorCodeName, invUid, custPOBox, docsDeliveryStatus, selfBilling, customerType, domainName, syncStatus, syncStatusDt, syncMode, collectionLeadNumber, status, paymentStatus, nettingInvoiceId, ownerId, ownerBpName, ownerBpBriefName. |
Success Response 200: List of Invoices
{
"data": [
{
"id": 0,
"invUid": "string",
"instanceID": 0,
"custID": 0,
"custName": "string",
"custShortName": "string",
"custAttn": "string",
"custAddress": "string",
"custAddress2": "string",
"custPost": "string",
"custCity": "string",
"custCountry": 0,
"custPOBox": "string",
"customerType": "string",
"custVatNumber": "string",
"invType": 0,
"invTypeName": "string",
"templateID": 0,
"invDate": "2021-06-24",
"invoicingDate": "2021-06-24",
"invoicingDatePolicy": "delivery",
"invNumberFix": "string",
"invNumberNum": 0,
"invNumber": "string",
"invPeriod": "string",
"invDueDate": "2021-06-24",
"overDueDate": 0,
"ownerVatNumber": "string",
"currency": 0,
"currencyCode": "string",
"amountNoVat": 0,
"amountVat": 0,
"vatPercent": 0,
"vat": 0,
"rounding": 0,
"total": 0,
"totalUnpaid": 0,
"totalPaid": 0,
"vatInPrice": 0,
"vatInTotal": 0,
"status": "draft",
"insertDt": "2021-06-24T15:16:33.214Z",
"statusDt": "2021-06-24T15:16:33.214Z",
"deliveryDate": "2021-06-24",
"invPeriodStart": "2021-06-24",
"invPeriodEnd": "2021-06-24",
"docsDeliveryStatus": "string",
"docsDeliveryStatusDate": "2021-06-24T15:16:33.214Z",
"docsDeliveryDlrStatus": "string",
"docsDeliveryDlrStatusDate": "2021-06-24T15:16:33.214Z",
"classCodeName": "string",
"classDomain": "string",
"classArea": "string",
"lang": "string",
"paymentStatus": "none",
"paymentStatusDate": "2021-06-24T15:16:33.214Z",
"disputeStatus": "string",
"disputeStatusDate": "2021-06-24T15:16:33.214Z",
"dataSourceId": 0,
"dataSourceCodeName": "string",
"nettingInvoiceId": 0,
"nettingInvoiceNumber": "string",
"selfBilling": "yes",
"domainId": 0,
"domainCodeName": "string",
"domainName": "string",
"disputeNextId": 0,
"collectionMode": "none",
"collectionLeadId": 0,
"collectionLeadNumber": "string",
"collectionLeadNettingInvoiceId": 0,
"collectionLeadNettingInvoiceNumber": "string",
"collectionLeadNettingInvoiceStatus": "string",
"collectionLeadNettingInvoicePaymentStatus": "string",
"collectionLeadNettingInvoiceTotal": "string",
"collectionLeadNettingInvoiceTotalPaid": "string",
"collectionLeadNettingInvoiceTotalUnpaid": "string",
"processingStatus": "none",
"nettingInvoiceStatus": "draft",
"nettingPaymentStatus": "none",
"nettingTotal": 0,
"nettingTotalUnpaid": 0,
"nettingTotalPaid": 0,
"dtsSelectorId": 0,
"dtsSelectorCodeName": "string",
"sitInvoiceEmailImportId": 0,
"syncStatus": "none",
"syncStatusDt": "2021-06-24T15:16:33.214Z",
"syncMode": "disabled",
"reminderStatus": "enabled",
"domesticCurrency": 0,
"domesticCurrencyCode": "string",
"domesticCurrencyAmountNoVAT": 0,
"domesticCurrencyAmountVAT": 0,
"domesticCurrencyTotal": 0,
"domesticCurrencyRounding": 0,
"domesticCurrencyRate": 0,
"industryName": "string",
"ownerName": "string",
"ownerId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string"
}
],
"meta": {
"pagination": {}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
The method returns a list of top-up Invoices.
Authorization privilege needed for this endpoint: finance-invoices.view.
Optional privilege used in this endpoint: finance-invoices-own.view.
This endpoint accepts query parameters described in URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
operator(fieldName) | string (query) | Search criteria. |
q | string (query) | General search criteria. The available fields are: custShortName, custName, invNumber, invDate, invoicingDate, invoicingDatePolicy, invDueDate, invTypeName, invPeriod, disputeStatus, ownerId, ownerBpName, ownerBpBriefName. |
page_size | integer (query) | Page size. The default value is 10. |
page_number | integer (query) | Page number. The default value is 1. . |
paging | string (query) | Paging options. The format is: &paging=page_num,page_size e.g. paging=1,10. |
sort | string (query) | Sort available fields: custName, custShortName, invNumber, invDate, invDueDate, overDueDate, total, totalUnpaid, totalPaid, invType, invTypeName, invPeriod, invPeriodStart, invPeriodEnd, invoicingDate, invoicingDatePolicy, classCodeName, currency, id, disputeStatus, statusDt, dataSourceCodeName, custID, processingStatus, collectionLeadId, collectionMode, vat, amountNoVat, amountVat, domainCodeName, custCountry, nettingInvoiceStatus, nettingInvoicePaymentStatus, rounding, dtsSelectorId, dtsSelectorCodeName, invUid, custPOBox, docsDeliveryStatus, selfBilling, customerType, domainName, syncStatus, syncStatusDt, syncMode, collectionLeadNumber, status, paymentStatus, nettingInvoiceId, ownerId, ownerBpName, ownerBpBriefName. |
Success Response 200: List of Invoices
{
"data": [
{
"id": 0,
"invUid": "string",
"instanceID": 0,
"custID": 0,
"custName": "string",
"custShortName": "string",
"custAttn": "string",
"custAddress": "string",
"custAddress2": "string",
"custPost": "string",
"custCity": "string",
"custCountry": 0,
"custPOBox": "string",
"customerType": "string",
"custVatNumber": "string",
"invType": 0,
"invTypeName": "string",
"templateID": 0,
"invDate": "2021-06-24",
"invoicingDate": "2021-06-24",
"invoicingDatePolicy": "delivery",
"invNumberFix": "string",
"invNumberNum": 0,
"invNumber": "string",
"invPeriod": "string",
"invDueDate": "2021-06-24",
"overDueDate": 0,
"ownerVatNumber": "string",
"currency": 0,
"currencyCode": "string",
"amountNoVat": 0,
"amountVat": 0,
"vatPercent": 0,
"vat": 0,
"rounding": 0,
"total": 0,
"totalUnpaid": 0,
"totalPaid": 0,
"vatInPrice": 0,
"vatInTotal": 0,
"status": "draft",
"insertDt": "2021-06-24T15:36:07.236Z",
"statusDt": "2021-06-24T15:36:07.236Z",
"deliveryDate": "2021-06-24",
"invPeriodStart": "2021-06-24",
"invPeriodEnd": "2021-06-24",
"docsDeliveryStatus": "string",
"docsDeliveryStatusDate": "2021-06-24T15:36:07.236Z",
"docsDeliveryDlrStatus": "string",
"docsDeliveryDlrStatusDate": "2021-06-24T15:36:07.236Z",
"classCodeName": "string",
"classDomain": "string",
"classArea": "string",
"lang": "string",
"paymentStatus": "none",
"paymentStatusDate": "2021-06-24T15:36:07.237Z",
"disputeStatus": "string",
"disputeStatusDate": "2021-06-24T15:36:07.237Z",
"dataSourceId": 0,
"dataSourceCodeName": "string",
"nettingInvoiceId": 0,
"nettingInvoiceNumber": "string",
"selfBilling": "yes",
"domainId": 0,
"domainCodeName": "string",
"domainName": "string",
"disputeNextId": 0,
"collectionMode": "none",
"collectionLeadId": 0,
"collectionLeadNumber": "string",
"collectionLeadNettingInvoiceId": 0,
"collectionLeadNettingInvoiceNumber": "string",
"collectionLeadNettingInvoiceStatus": "string",
"collectionLeadNettingInvoicePaymentStatus": "string",
"collectionLeadNettingInvoiceTotal": "string",
"collectionLeadNettingInvoiceTotalPaid": "string",
"collectionLeadNettingInvoiceTotalUnpaid": "string",
"processingStatus": "none",
"nettingInvoiceStatus": "draft",
"nettingPaymentStatus": "none",
"nettingTotal": 0,
"nettingTotalUnpaid": 0,
"nettingTotalPaid": 0,
"dtsSelectorId": 0,
"dtsSelectorCodeName": "string",
"sitInvoiceEmailImportId": 0,
"syncStatus": "none",
"syncStatusDt": "2021-06-24T15:36:07.237Z",
"syncMode": "disabled",
"reminderStatus": "enabled",
"domesticCurrency": 0,
"domesticCurrencyCode": "string",
"domesticCurrencyAmountNoVAT": 0,
"domesticCurrencyAmountVAT": 0,
"domesticCurrencyTotal": 0,
"domesticCurrencyRounding": 0,
"domesticCurrencyRate": 0,
"industryName": "string",
"ownerName": "string",
"ownerId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string"
}
],
"meta": {
"pagination": {}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
The method returns a list of part payment Invoices.
Authorization privilege needed for this endpoint: finance-invoices.view.
Optional privilege used in this endpoint: finance-invoices-own.view.
This endpoint accepts query parameters described in URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
operator(fieldName) | string (query) | Search criteria. |
q | string (query) | General search criteria. The available fields are: custShortName, custName, invNumber, invDate, invoicingDate, invoicingDatePolicy, invDueDate, invTypeName, invPeriod, disputeStatus, ownerId, ownerBpName, ownerBpBriefName. |
page_size | integer (query) | Page size. The default value is 10. |
page_number | integer (query) | Page number. The default value is 1. . |
paging | string (query) | Paging options. The format is: &paging=page_num,page_size e.g. paging=1,10. |
sort | string (query) | Sort available fields: custName, custShortName, invNumber, invDate, invDueDate, overDueDate, total, totalUnpaid, totalPaid, invType, invTypeName, invPeriod, invPeriodStart, invPeriodEnd, invoicingDate, invoicingDatePolicy, classCodeName, currency, id, disputeStatus, statusDt, dataSourceCodeName, custID, processingStatus, collectionLeadId, collectionMode, vat, amountNoVat, amountVat, domainCodeName, custCountry, nettingInvoiceStatus, nettingInvoicePaymentStatus, rounding, dtsSelectorId, dtsSelectorCodeName, invUid, custPOBox, docsDeliveryStatus, selfBilling, customerType, domainName, syncStatus, syncStatusDt, syncMode, collectionLeadNumber, status, paymentStatus, nettingInvoiceId, ownerId, ownerBpName, ownerBpBriefName. |
Success Response 200: List of Invoices
{
"data": [
{
"id": 0,
"invUid": "string",
"instanceID": 0,
"custID": 0,
"custName": "string",
"custShortName": "string",
"custAttn": "string",
"custAddress": "string",
"custAddress2": "string",
"custPost": "string",
"custCity": "string",
"custCountry": 0,
"custPOBox": "string",
"customerType": "string",
"custVatNumber": "string",
"invType": 0,
"invTypeName": "string",
"templateID": 0,
"invDate": "2021-06-24",
"invoicingDate": "2021-06-24",
"invoicingDatePolicy": "delivery",
"invNumberFix": "string",
"invNumberNum": 0,
"invNumber": "string",
"invPeriod": "string",
"invDueDate": "2021-06-24",
"overDueDate": 0,
"ownerVatNumber": "string",
"currency": 0,
"currencyCode": "string",
"amountNoVat": 0,
"amountVat": 0,
"vatPercent": 0,
"vat": 0,
"rounding": 0,
"total": 0,
"totalUnpaid": 0,
"totalPaid": 0,
"vatInPrice": 0,
"vatInTotal": 0,
"status": "draft",
"insertDt": "2021-06-24T15:42:18.110Z",
"statusDt": "2021-06-24T15:42:18.110Z",
"deliveryDate": "2021-06-24",
"invPeriodStart": "2021-06-24",
"invPeriodEnd": "2021-06-24",
"docsDeliveryStatus": "string",
"docsDeliveryStatusDate": "2021-06-24T15:42:18.110Z",
"docsDeliveryDlrStatus": "string",
"docsDeliveryDlrStatusDate": "2021-06-24T15:42:18.110Z",
"classCodeName": "string",
"classDomain": "string",
"classArea": "string",
"lang": "string",
"paymentStatus": "none",
"paymentStatusDate": "2021-06-24T15:42:18.110Z",
"disputeStatus": "string",
"disputeStatusDate": "2021-06-24T15:42:18.110Z",
"dataSourceId": 0,
"dataSourceCodeName": "string",
"nettingInvoiceId": 0,
"nettingInvoiceNumber": "string",
"selfBilling": "yes",
"domainId": 0,
"domainCodeName": "string",
"domainName": "string",
"disputeNextId": 0,
"collectionMode": "none",
"collectionLeadId": 0,
"collectionLeadNumber": "string",
"collectionLeadNettingInvoiceId": 0,
"collectionLeadNettingInvoiceNumber": "string",
"collectionLeadNettingInvoiceStatus": "string",
"collectionLeadNettingInvoicePaymentStatus": "string",
"collectionLeadNettingInvoiceTotal": "string",
"collectionLeadNettingInvoiceTotalPaid": "string",
"collectionLeadNettingInvoiceTotalUnpaid": "string",
"processingStatus": "none",
"nettingInvoiceStatus": "draft",
"nettingPaymentStatus": "none",
"nettingTotal": 0,
"nettingTotalUnpaid": 0,
"nettingTotalPaid": 0,
"dtsSelectorId": 0,
"dtsSelectorCodeName": "string",
"sitInvoiceEmailImportId": 0,
"syncStatus": "none",
"syncStatusDt": "2021-06-24T15:42:18.111Z",
"syncMode": "disabled",
"reminderStatus": "enabled",
"domesticCurrency": 0,
"domesticCurrencyCode": "string",
"domesticCurrencyAmountNoVAT": 0,
"domesticCurrencyAmountVAT": 0,
"domesticCurrencyTotal": 0,
"domesticCurrencyRounding": 0,
"domesticCurrencyRate": 0,
"industryName": "string",
"ownerName": "string",
"ownerId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string"
}
],
"meta": {
"pagination": {}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.2 Invoice Clearing
Endpoints for working with invoice clearing.
Method Overview
The method returns a list of all InvoiceClearingRecords that belongs to InvoiceClearing.
InvoiceClearing is created when Invoice status is changed to approved and payment status is set to 'open'. By default, only clearing records with active status will be returned.
If Clearing records with other statuses should be returned, use query parameter status with operator 'in' and value containing comma separated list of statuses ( in(status)=active,canceled ). For the time being, only active and canceled status are available as clearing record status value.
Authorization privilege needed for this endpoint: finance-invoices.view.
Optional privilege used in this endpoint: finance-invoices-own.view.
This endpoint accepts query parameters described in URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
invoiceid (required) | integer (path) | Invoice ID to get ClearingRecords. |
operator(fieldName) | string (query) | Search criteria. |
q | string (query) | General search criteria. The available fields are: status, paymentReference, comment, revokeUserId, revokeUserName, revokeComment, clearingTypeCodeName, paymentTypeName, bankAccountName, bankAccountNumber, bankAccountIban, bankAccountSwiftBic. |
page_size | integer (query) | Page size. The default value is 10. |
page_number | integer (query) | Page number. The default value is 1. . |
paging | string (query) | Paging options. The format is: &paging=page_num,page_size e.g. paging=1,10. |
sort | string (query) | Sort available fields: id, clearingId, clearingTypeId, clearingTypeCodeName, recordDate, paymentTypeId, paymentTypeName, amountIncrement, paidAmount, paymentReference, comment, status, statusDate, bankAccountId, bankAccountName, bankAccountNumber, bankAccountIban, bankAccountSwiftBic, revokeUserId, revokeUserName, revokeComment. |
Success Response 200: List of InvoiceClearingRecords
{
"data": [
{
"id": 0,
"clearingId": 0,
"clearingTypeId": 0,
"clearingTypeCodeName": "string",
"recordDate": "2021-06-24",
"paymentTypeId": 0,
"paymentTypeName": "string",
"amountIncrement": 0,
"paidAmount": 0,
"paymentReference": "string",
"status": "string",
"statusDate": "2021-06-24T15:45:20.178Z",
"revokeUserId": "string",
"revokeUserName": "string",
"revokeComment": "string",
"bankAccountId": 0,
"bankAccountName": "string",
"bankAccountNumber": "string",
"bankAccountIban": "string",
"bankAccountSwiftBic": "string"
}
],
"meta": {
"pagination": {}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
The method creates an Invoice Clearing record.
Authorization privilege needed for this endpoint:
- finance-invoices.manage or
- finance-cust-invoices.manage or
- finance-supplier-invoices.manage or
- finance-netting-invoices.manage.
InvoiceClearing is created when Invoice status is changed to approved and payment status is set to 'open'.
Approved supplier invoices with payment status 'on-hold' do not have clearing created. Clearing record for supplier invoice is created when a supplier invoice is approved for payment.
Invoice clearing record can not be added if invoice does not have Clearing created.
When totalUnpaid is 0, invoice.paymentStatus is set to closed.
'clearingType' type can be:
1 - Invoice = amount increment, is auto-generated when invoice status is changed to approved
2 - Payment = paidAmount - must be <> 0
3 - Interest = amount increment - must be <> 0
4 - Reminder = amount increment - must be <> 0
'paymentType' type can be:
1 - Bank Transfer
2 - Credit Card
3 - Paypal
4 - Cash
If paymentType is '1 - Bank Transfer' bankAccountId greater than 0 should be sent, in other cases it should not be sent or can be 0. Status is set to 'active' comment is set to name of clearingType if omitted recordDate must be in format 2006-01-02.
If clearing record represents payment and invoice is document class code name is CUSTOMER_INVOICE payment will be automatically applied to billing balance.
URL Parameters
Name | Type | Description |
---|---|---|
invoiceid (required) | string (path) | Invoice ID to get. |
post data (required) | object (body) | If used status must be either active or deleted. recordDate must be in format YYYY-MM-DD. |
Data Parameters
post data object
{
"clearingTypeId": 0,
"recordDate": "2021-06-24",
"paymentTypeId": 0,
"amountIncrement": 0,
"paidAmount": 0,
"paymentReference": "string",
"bankAccountId": 0
}
Success Response: 200 InvoiceClearingRecord added
{
"id": 0,
"clearingId": 0,
"clearingTypeId": 0,
"clearingTypeCodeName": "string",
"recordDate": "2021-06-24",
"paymentTypeId": 0,
"paymentTypeName": "string",
"amountIncrement": 0,
"paidAmount": 0,
"paymentReference": "string",
"status": "string",
"statusDate": "2021-06-24T15:52:15.170Z",
"revokeUserId": "string",
"revokeUserName": "string",
"revokeComment": "string",
"bankAccountId": 0,
"bankAccountName": "string",
"bankAccountNumber": "string",
"bankAccountIban": "string",
"bankAccountSwiftBic": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
The method returns a list of all InvoiceClearingRecords that belongs to InvoiceClearing.
InvoiceClearing is created when Invoice status is changed to approved and payment status is set to 'open'. By default, only clearing records with active status will be returned.
If Clearing records with other statuses should be returned, use query parameter status with operator 'in' and value containing comma separated list of statuses ( in(status)=active,canceled ). For the time being, only active and canceled status are available as clearing record status value.
Authorization privilege needed for this endpoint: finance-invoices.view.
Optional privilege used in this endpoint: finance-invoices-own.view.
This endpoint accepts query parameters described in URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
invoiceNumber (required) | integer (path) | Invoice number to get ClearingRecords. If the invoice number contains slashes, it must be encoded. / = %2F. |
operator(fieldName) | string (query) | Search criteria using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and by following attributes: id, clearingId, clearingTypeId, clearingTypeCodeName, recordDate, paymentTypeId, paymentTypeName, amountIncrement, paidAmount, paymentReference, comment, status, statusDate, bankAccountId, bankAccountName, bankAccountNumber, bankAccountIban, bankAccountSwiftBic, revokeUserId, revokeUserName, revokeComment. If operator is one of isnull, isnotnull, isempty, isnotempty field value can be omitted. If operator is in or notin field value must be comma separated list of values. If operator is between or notbetween field value must be comma separated list of two values representing beginning and the end of range. Operator can be omitted and in that case it will be treated as operator is eq (Eg: fieldName=fieldValue). |
q | string (query) | General search criteria. The available fields are: status, paymentReference, comment, revokeUserId, revokeUserName, revokeComment, clearingTypeCodeName, paymentTypeName, bankAccountName, bankAccountNumber, bankAccountIban, bankAccountSwiftBic. |
page_size | integer (query) | Page size. The default value is 10. |
page_number | integer (query) | Page number. The default value is 1. . |
paging | string (query) | Paging options. The format is: &paging=page_num,page_size e.g. paging=1,10. |
sort | string (query) | Sort available fields: id, clearingId, clearingTypeId, clearingTypeCodeName, recordDate, paymentTypeId, paymentTypeName, amountIncrement, paidAmount, paymentReference, comment, status, statusDate, bankAccountId, bankAccountName, bankAccountNumber, bankAccountIban, bankAccountSwiftBic, revokeUserId, revokeUserName, revokeComment. |
Success Response 200: List of InvoiceClearingRecords
{
"data": [
{
"id": 0,
"clearingId": 0,
"clearingTypeId": 0,
"clearingTypeCodeName": "string",
"recordDate": "2021-06-24",
"paymentTypeId": 0,
"paymentTypeName": "string",
"amountIncrement": 0,
"paidAmount": 0,
"paymentReference": "string",
"comment": "string",
"status": "string",
"statusDate": "2021-06-24T15:58:31.845Z",
"revokeUserId": "string",
"revokeUserName": "string",
"revokeComment": "string",
"bankAccountId": 0,
"bankAccountName": "string",
"bankAccountNumber": "string",
"bankAccountIban": "string",
"bankAccountSwiftBic": "string"
}
],
"meta": {
"pagination": {}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
The method adds an Invoice Clearing Record.
Authorization privilege needed for this endpoint:
finance-invoices.manage or
- finance-cust-invoices.manage or
- finance-supplier-invoices.manage or
- finance-netting-invoices.manage.
Invoice Clearing is created when Invoice status is changed to approved and payment status is set to 'open'.
Approved supplier invoices with payment status 'on-hold' do not have clearing created. Clearing record for supplier invoice is created when a supplier invoice is approved for payment.
Invoice clearing record can not be added if invoice do not have Clearing created.
When totalUnpaid is 0, invoice.paymentStatus is set to closed.
'clearingType' type can be:
1 - Invoice = amount increment, is auto-generated when invoice status is changed to approved
2 - Payment = paidAmount - must be <> 0
3 - Interest = amount increment - must be <> 0
4 - Reminder = amount increment - must be <> 0
'paymentType' type can be:
1 - Bank Transfer
2 - Credit Card
3 - Paypal
4 - Cash
If paymentType is '1 - Bank Transfer' bankAccountId greater than 0 should be sent, in other cases it should not be sent or can be 0.
Status is set to 'active' comment is set to name of clearingType if omitted recordDate must be in format 2006-01-02.
If clearing record represents payment and invoice document class code name is CUSTOMER_INVOICE payment will be automatically applied to billing balance.
URL Parameters
Name | Type | Description |
---|---|---|
invoiceNumber (required) | string (path) | Invoice number to get ClearingRecords for. If it contains slashes, they must be encoded with / = %2F. |
post data (required) | object (body) | recordDate must be in format YYYY-MM-DD. |
Data Parameters
post data object
{
"clearingTypeId": 0,
"recordDate": "2021-06-25",
"paymentTypeId": 0,
"amountIncrement": 0,
"paidAmount": 0,
"paymentReference": "string",
"comment": "string",
"bankAccountId": 0
}
Success Response: 200 InvoiceClearingRecord added
{
"id": 0,
"clearingId": 0,
"clearingTypeId": 0,
"clearingTypeCodeName": "string",
"recordDate": "2021-06-25",
"paymentTypeId": 0,
"paymentTypeName": "string",
"amountIncrement": 0,
"paidAmount": 0,
"paymentReference": "string",
"comment": "string",
"status": "string",
"statusDate": "2021-06-25T03:39:29.762Z",
"revokeUserId": "string",
"revokeUserName": "string",
"revokeComment": "string",
"bankAccountId": 0,
"bankAccountName": "string",
"bankAccountNumber": "string",
"bankAccountIban": "string",
"bankAccountSwiftBic": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
The method returns a list of all InvoiceClearingRecords.
Authorization privilege needed for this endpoint:
finance-invoices.manage or
- finance-cust-invoices.manage or
- finance-supplier-invoices.manage or
- finance-netting-invoices.manage.
InvoiceClearing is created when Invoice status is changed to approved and payment status is set to 'open'.
Approved supplier invoices with payment status 'on-hold' do not have clearing created. Clearing record for supplier invoice is created when a supplier invoice is approved for payment.
Invoice clearing record can not be added if invoice do not have Clearing created.
When totalUnpaid is 0, invoice.paymentStatus is set to closed.
'clearingType' type can be:
1 - Invoice = amount increment, is auto-generated when invoice status is changed to approved
2 - Payment = paidAmount - must be <> 0
3 - Interest = amount increment - must be <> 0
4 - Reminder = amount increment - must be <> 0
'paymentType' type can be:
1 - Bank Transfer
2 - Credit Card
3 - Paypal
4 - Cash
If paymentType is '1 - Bank Transfer' bankAccountId greater than 0 should be sent, in other cases it should not be sent or can be 0.
Status is set to 'active', comment is set to name of clearingType, if omitted recordDate must be in format 2006-01-02.
If clearing record represents payment and invoice document class code name is CUSTOMER_INVOICE payment will be automatically applied to billing balance.
This endpoint accepts query parameters described in URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
invoiceUid (required) | integer (path) | Invoice UID to get ClearingRecords. If the invoice number contains slashes, it must be encoded. / = %2F. |
operator(fieldName) | string (query) | Search criteria using following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and by following attributes: id, clearingId, clearingTypeId, clearingTypeCodeName, recordDate, paymentTypeId, paymentTypeName, amountIncrement, paidAmount, paymentReference, comment, status, statusDate, bankAccountId, bankAccountName, bankAccountNumber, bankAccountIban, bankAccountSwiftBic, revokeUserId, revokeUserName, revokeComment. If operator is one of isnull, isnotnull, isempty, isnotempty field value can be omitted. If operator is in or notin field value must be comma separated list of values. If operator is between or notbetween field value must be comma separated list of two values representing beginning and the end of range. Operator can be omitted and in that case it will be treated as operator is eq (Eg: fieldName=fieldValue). |
q | string (query) | General search criteria. The available fields are: status, paymentReference, comment, revokeUserId, revokeUserName, revokeComment, clearingTypeCodeName, paymentTypeName, bankAccountName, bankAccountNumber, bankAccountIban, bankAccountSwiftBic. |
page_size | integer (query) | Page size. The default value is 10. |
page_number | integer (query) | Page number. The default value is 1. . |
paging | string (query) | Paging options. The format is: &paging=page_num,page_size e.g. paging=1,10. |
sort | string (query) | Sort available fields: id, clearingId, clearingTypeId, clearingTypeCodeName, recordDate, paymentTypeId, paymentTypeName, amountIncrement, paidAmount, paymentReference, comment, status, statusDate, bankAccountId, bankAccountName, bankAccountNumber, bankAccountIban, bankAccountSwiftBic, revokeUserId, revokeUserName, revokeComment. |
Success Response 200: List of InvoiceClearingRecords
{
"data": [
{
"id": 0,
"clearingId": 0,
"clearingTypeId": 0,
"clearingTypeCodeName": "string",
"recordDate": "2021-06-25",
"paymentTypeId": 0,
"paymentTypeName": "string",
"amountIncrement": 0,
"paidAmount": 0,
"paymentReference": "string",
"comment": "string",
"status": "string",
"statusDate": "2021-06-25T03:44:55.211Z",
"revokeUserId": "string",
"revokeUserName": "string",
"revokeComment": "string",
"bankAccountId": 0,
"bankAccountName": "string",
"bankAccountNumber": "string",
"bankAccountIban": "string",
"bankAccountSwiftBic": "string"
}
],
"meta": {
"pagination": {}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
The method adds an Invoice Clearing record.
Authorization privilege needed for this endpoint:
finance-invoices.manage or
- finance-cust-invoices.manage or
- finance-supplier-invoices.manage or
- finance-netting-invoices.manage.
InvoiceClearing is created when Invoice status is changed to approved and payment status is set to 'open'.
Approved supplier invoices with payment status 'on-hold' do not have clearing created. Clearing record for supplier invoice is created when a supplier invoice is approved for payment.
Invoice clearing record can not be added if invoice do not have Clearing created.
When totalUnpaid is 0, invoice.paymentStatus is set to closed.
'clearingType' type can be:
1 - Invoice = amount increment, is auto-generated when invoice status is changed to approved
2 - Payment = paidAmount - must be <> 0
3 - Interest = amount increment - must be <> 0
4 - Reminder = amount increment - must be <> 0
'paymentType' type can be:
1 - Bank Transfer
2 - Credit Card
3 - Paypal
4 - Cash
If paymentType is '1 - Bank Transfer' bankAccountId greater than 0 should be sent, in other cases it should not be sent or can be 0.
Status is set to 'active' comment is set to name of clearingType if omitted recordDate must be in format 2006-01-02
If clearing record represents payment and invoice document class code name is CUSTOMER_INVOICE payment will be automatically applied to billing balance.
URL Parameters
Name | Type | Description |
---|---|---|
invoiceUid (required) | string (path) | Invoice UID. |
post data (required) | object (body) | recordDate must be in format YYYY-MM-DD. |
Data Parameters
post data object
{
"clearingTypeId": 0,
"recordDate": "2021-06-25",
"paymentTypeId": 0,
"amountIncrement": 0,
"paidAmount": 0,
"paymentReference": "string",
"comment": "string",
"bankAccountId": 0
}
Success Response: 200 InvoiceClearingRecord added
{
"id": 0,
"clearingId": 0,
"clearingTypeId": 0,
"clearingTypeCodeName": "string",
"recordDate": "2021-06-25",
"paymentTypeId": 0,
"paymentTypeName": "string",
"amountIncrement": 0,
"paidAmount": 0,
"paymentReference": "string",
"comment": "string",
"status": "string",
"statusDate": "2021-06-25T03:57:08.772Z",
"revokeUserId": "string",
"revokeUserName": "string",
"revokeComment": "string",
"bankAccountId": 0,
"bankAccountName": "string",
"bankAccountNumber": "string",
"bankAccountIban": "string",
"bankAccountSwiftBic": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.3 Payment Type
Endpoints for working with Payment Type.
Method Overview
The method returns a list of all available payment types.
Authorization privilege needed for this endpoint: finance-invoices.view.
Optional privilege used in this endpoint: finance-invoices-own.view.
This endpoint accepts query parameters described in URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
operator(fieldName) | string (query) | Search criteria using following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and by following attributes: id, name, status, statusDt. If operator is one of isnull, isnotnull, isempty, isnotempty field value can be omitted. If operator is in or notin field value must be comma separated list of values. If operator is between or notbetween field value must be comma separated list of two values representing beginning and the end of range. Operator can be omitted and in that case it will be treated as operator is eq (Eg: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field clientName. If fieldName is q and operator is eq or omitted, field value will be used in general search across multiple attributes. |
q | string (query) | General search criteria. The available fields are: name, status. |
page_size | integer (query) | Page size. Default value is 10. |
page_number | integer (query) | Page number. The default value is 1. . |
paging | string (query) | Paging options. The format is: &paging=page_num,page_size e.g. paging=1,10. |
sort | string (query) | Sort available fields: id, name, status, statusDt. |
Success Response 200: List of Payment Types
{
"data": [
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-06-25T03:59:13.188Z"
}
],
"meta": {
"pagination": {}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.4 Total Balances
Endpoints for working with Total Balances.
Method Overview
The method lists active and blocked prepaid total balances with filtering and pagination features.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for given criteria. |
operator(fieldName) | string (query) | Search criteria using following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, and by following properties: id, bizPartnerId, currency, name, status, alertsPolicyId, alertsBaseAmount, bizPartnerName, bizPartnerShortName, alertsPolicyName, paidTotal, unpaidTotal, billedTotal, overdraftLimit, debitBalanceThreshold, pricePackageMode, pricePackageId, overdraftPriceListId, ownerId, ownerBpName, ownerBpBriefName, alertsLanguage, amount, smsCount, accountsTotal, usage, availableAmount, totalCredit, isDefault. If operator is one of isnull, isnotnull, isempty, isnotempty field value can be omitted. If operator is in or notin field value must be comma separated list of values. If operator is between or notbetween field value must be comma separated list of two values representing beginning and the end of range. Operator can be omitted and in that case it will be treated as operator is eq (Eg fieldName=fieldValue) Example: startswith(clientName)=hor, starts with hor in field clientName. If propertyName is q and operator is eq or omitted, property value will be used in general search across multiple attributes. |
q | string (query) | General search criteria. The available fields are: name, status. |
page_size. | integer (query) | Page size. Default value is 10. |
page_number | integer (query) | Page number. The default value is 1. |
paging | string (query) | Paging options. The format is: &paging=page_num,page_size e.g. paging=1,10. |
sort | string (query) | Sort available fields: id, bizPartnerId, currency, name, status, alertsPolicyId, alertsBaseAmount, bizPartnerName, bizPartnerShortName, alertsPolicyName, paidTotal, unpaidTotal, billedTotal, overdraftLimit, debitBalanceThreshold, pricePackageMode, pricePackageId, overdraftPriceListId, ownerId, ownerBpName, ownerBpBriefName, alertsLanguage, amount, smsCount, accountsTotal, usage, availableAmount, totalCredit, isDefault. |
Success Response 200: Total Balances collection
{
"data": [
{
"id": 0,
"name": "string",
"bizPartnerId": 0,
"bizPartnerName": "string",
"bizPartnerShortName": "string",
"billingTypeCodeName": "PREPAID",
"billingTypeName": "string",
"status": "active",
"smsCount": 0,
"amount": 0,
"accountsTotal": 0,
"billedTotal": 0,
"creditTotal": 0,
"paidTotal": 0,
"unpaidTotal": 0,
"usage": 0,
"totalCredit": 0,
"availableAmount": 0,
"currency": 0,
"currencyCode": "string",
"currencyName": "string",
"overdraftLimit": 0,
"billingCreditLimit": 0,
"billingOverdraftLimit": 0,
"limitsCurrency": 0,
"billingDebitThreshold": 0,
"disputePercent": 0,
"disputeValue": 0,
"paymentTermsDays": 0,
"pricePackageMode": "on",
"pricePackageId": 0,
"overdraftPriceListId": 0,
"invoiceSending": "on",
"blockOnOutOfCredit": "on",
"minUsageAmount": 0,
"reportCycleUnit": "string",
"reportCycle": 0,
"reportStartDate": "2021-06-25",
"nextReportDate": "2021-06-25",
"lastBillingReportId": 0,
"alertsBaseAmount": 0,
"alertsPolicyId": 0,
"alertsPolicyName": "string",
"alertsLanguage": "string",
"ownerId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string",
"isDefault": "yes"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"perPage": 0,
"currentPage": 0,
"totalPages": 0
}
}
}
Error Response Unexpected Error: Default
{
"code": 0,
"message": "string",
"description": "string",
"items": [
{
"name": "string",
"message": "string",
"description": "string"
}
]
}
Method Overview
The method lists active and blocked postpaid total balances with filtering and pagination features.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for given criteria. |
operator(fieldName) | string (query) | Search criteria using following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and by following properties: id, bizPartnerId, currency, name, status, alertsPolicyId, alertsBaseAmount, bizPartnerName, bizPartnerShortName, alertsPolicyName, paidTotal, unpaidTotal, billedTotal, overdraftLimit, debitBalanceThreshold, pricePackageMode, pricePackageId, overdraftPriceListId, ownerId, ownerBpName, ownerBpBriefName, alertsLanguage, amount, smsCount, accountsTotal, usage, availableAmount, debitLimit, debitTotal, isDefault. If operator is one of isnull, isnotnull, isempty, isnotempty field value can be omitted. If operator is in or notin field value must be comma separated list of values. If operator is between or notbetween field value must be comma separated list of two values representing beginning and the end of range. Operator can be omitted and in that case it will be treated as operator is eq (Eg fieldName=fieldValue) Example: startswith(clientName)=hor, starts with hor in field clientName if propertyName is q and operator is eq or omitted, property value will be used in general search across multiple attributes. |
q | string (query) | General search criteria. The available fields are: name, status. |
page_size | integer (query) | Page size. Default value is 10. |
page_number | integer (query) | Page number. The default value is 1. |
paging | string (query) | Paging options. The format is: &paging=page_num,page_size e.g. paging=1,10. |
sort | string (query) | Sort available fields: id, bizPartnerId, currency, name, status, alertsPolicyId, alertsBaseAmount, bizPartnerName, bizPartnerShortName, alertsPolicyName, paidTotal, unpaidTotal, billedTotal, overdraftLimit, debitBalanceThreshold, pricePackageMode, pricePackageId, overdraftPriceListId, ownerId, ownerBpName, ownerBpBriefName, alertsLanguage, amount, smsCount, accountsTotal, usage, availableAmount, totalCredit, isDefault. |
Success Response 200: Total Balances collection
{
"data": [
{
"id": 0,
"name": "string",
"bizPartnerId": 0,
"bizPartnerName": "string",
"bizPartnerShortName": "string",
"billingTypeCodeName": "PREPAID",
"billingTypeName": "string",
"status": "active",
"smsCount": 0,
"amount": 0,
"accountsTotal": 0,
"billedTotal": 0,
"paidTotal": 0,
"unpaidTotal": 0,
"usage": 0,
"debitLimitTotal": 0,
"availableAmount": 0,
"billingTriggerAmount": 0,
"currency": 0,
"currencyCode": "string",
"currencyName": "string",
"creditLimit": 0,
"overdraftLimit": 0,
"billingDebitLimit": 0,
"billingOverdraftLimit": 0,
"limitsCurrency": 0,
"billingDebitThreshold": 0,
"disputePercent": 0,
"disputeValue": 0,
"paymentTermsDays": 0,
"pricePackageMode": "on",
"pricePackageId": 0,
"overdraftPriceListId": 0,
"invoiceSending": "on",
"blockOnOutOfCredit": "on",
"minUsageAmount": 0,
"billingCycleUnit": "string",
"billingCycle": 0,
"billingStartDate": "2021-06-25",
"nextBillingDate": "2021-06-25",
"lastBillingRecordId": 0,
"alertsBaseAmount": 0,
"alertsPolicyId": 0,
"alertsPolicyName": "string",
"alertsLanguage": "string",
"ownerId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string",
"isDefault": "yes"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"perPage": 0,
"currentPage": 0,
"totalPages": 0
}
}
}
Error Response Unexpected Error: Default
{
"code": 0,
"message": "string",
"description": "string",
"items": [
{
"name": "string",
"message": "string",
"description": "string"
}
]
}
3.5 Credit Records
Endpoints for working with Credit Records.
Method Overview
The method returns a list of active and blocked postpaid total balances.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for given criteria. |
operator(fieldName) | string (query) | Search criteria using following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and by following properties: id, balanceId, creditUid, date, currency, currencyCode, currencyName, amount, paidAmount, unpaidAmount, conditionalAmount, creditAmount, status, isAggregateRecord, aggregateFromDate, invoiceId, balanceName, bizPartnerName, bizPartnerShortName, ownerId, ownerBpName, ownerBpBriefName. If operator is one of isnull, isnotnull, isempty, isnotempty field value can be omitted. If operator is in or notin field value must be comma separated list of values. If operator is between or notbetween field value must be comma separated list of two values representing beginning and the end of range. Operator can be omitted and in that case it will be treated as operator is eq (Eg fieldName=fieldValue) Example: startswith(clientName)=hor, starts with hor in field clientName if propertyName is q and operator is eq or omitted, property value will be used in general search across multiple attributes. |
page_size | integer (query) | Page size. The default value is 10. |
page_number | integer (query) | Page number. The default value is 1. |
paging | string (query) | Paging options. The format is: &paging=page_num,page_size e.g. paging=1,10. |
fields | string (query) | Comma separated list of attributes that needs to be returned in partial response. |
sort | string (query) | Sort available fields: id, balanceId, instanceId, creditUid, date, currency, currencyCode, currencyName, amount, paidAmount, unpaidAmount, conditionalAmount, creditAmount, status, isAggregateRecord, aggregateFromDate, invoiceId, balanceName, bizPartnerName, bizPartnerShortName, ownerId, ownerBpName, ownerBpBriefName. |
Success Response 200: Credit records collection
{
"data": [
{
"id": 0,
"creditUid": "string",
"balanceId": 0,
"activationDate": "2021-06-30",
"creationDate": "2021-06-30",
"amount": 0,
"currency": 0,
"creditAmount": 0,
"conditionalAmount": 0,
"paidAmount": 0,
"unpaidAmount": 0,
"status": "string",
"isAggregateRecord": "string",
"aggregateFromDate": "2021-06-30",
"invoiceId": 0,
"bizPartnerName": "string",
"bizPartnerShortName": "string",
"bizPartnerId": 0,
"balanceName": "string",
"typeId": 0,
"billingRecordId": 0,
"type": "string",
"typeName": "string",
"createInvoice": "yes",
"billingType": 0,
"currencyCode": "string",
"currencyName": "string",
"orderingStatus": "off",
"orderingStatusDt": "2021-06-30T11:08:35.518Z",
"selectedPriceListId": 0,
"ownerId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string",
"description": "string",
"comment": "string",
"invoice": {
"id": 0,
"instanceID": 0,
"custID": 0,
"custName": "string",
"custShortName": "string",
"custAttn": "string",
"custAddress": "string",
"custAddress2": "string",
"custPost": "string",
"custCity": "string",
"custCountry": 0,
"custPOBox": "string",
"custVatNumber": "string",
"invType": 0,
"invTypeName": "string",
"templateID": 0,
"invDate": "string",
"invNumberFix": "string",
"invNumberNum": 0,
"invNumber": "string",
"invPeriod": "string",
"invDueDate": "string",
"overDueDate": 0,
"ownerVatNumber": "string",
"currency": 0,
"currencyCode": "string",
"amountNoVat": 0,
"amountVat": 0,
"vatPercent": 0,
"rounding": 0,
"total": 0,
"totalUnpaid": 0,
"vatInPrice": 0,
"vatInTotal": 0,
"status": "string",
"insertDt": "string",
"statusDt": "string",
"deliveryDate": "string",
"invPeriodStart": "string",
"invPeriodEnd": "string",
"docsDeliveryStatus": "string",
"docsDeliveryStatusDate": "string",
"docsDeliveryDlrStatus": "string",
"docsDeliveryDlrStatusDate": "string",
"selfBilling": "yes",
"totalPaid": 0,
"classCodeName": "string",
"classDomain": "string",
"classArea": "string",
"lang": "string",
"paymentStatus": "none",
"paymentStatusDate": "2021-06-30T11:08:35.519Z",
"disputeStatus": "string",
"disputeStatusDate": "2021-06-30T11:08:35.519Z",
"dataSourceId": 0,
"dataSourceCodeName": "string",
"nettingInvoiceId": 0,
"nettingInvoiceNumber": "string",
"domainId": 0,
"domainCodeName": "string",
"disputeNextId": 0,
"collectionMode": "none",
"collectionLeadId": 0,
"processingStatus": "none",
"dtsSelectorId": 0,
"dtsSelectorCodeName": "string",
"ownerId": 0,
"items": [
{
"id": 0,
"invoiceId": 0,
"ordNum": 0,
"name": "string",
"itemType": "string",
"quantity": 0,
"quantityMore": 0,
"quantityMode": 0,
"measureUnit": 0,
"price": 0,
"vatInPrice": 0,
"totalNoVat": 0,
"totalVat": 0,
"status": "string",
"insertDt": "string",
"statusDt": "string",
"dataSourceId": 0,
"dataSourceForeignKey": 0,
"dtsSelectorId": 0,
"dtsSelectorCodeName": "string"
}
]
}
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"perPage": 0,
"currentPage": 0,
"totalPages": 0
}
}
}
Error Response Unexpected Error: Default
{
"code": 0,
"message": "string",
"description": "string",
"items": [
{
"name": "string",
"message": "string",
"description": "string"
}
]
}
Method Overview
The method creates a prepaid top-up.
URL Parameters
Name | Type | Description |
---|---|---|
credit record create (required) | (body) | New credit record to store. |
fields | string (query) | Comma separated list of attributes that needs to be returned in partial response. |
Data Parameters
post data object
{
"balanceId": 0,
"amount": 0,
"creditAmount": 0,
"typeId": 0,
"comment": "string",
"payment": {
"fullyPaid": true,
"paymentType": 0,
"bankAccountId": 0
}
}
Success Response: 200 Created credit record object
{
"id": 0,
"creditUid": "string",
"balanceId": 0,
"activationDate": "2021-06-30",
"creationDate": "2021-06-30",
"amount": 0,
"currency": 0,
"creditAmount": 0,
"conditionalAmount": 0,
"paidAmount": 0,
"unpaidAmount": 0,
"status": "string",
"isAggregateRecord": "string",
"aggregateFromDate": "2021-06-30",
"invoiceId": 0,
"bizPartnerName": "string",
"bizPartnerShortName": "string",
"bizPartnerId": 0,
"balanceName": "string",
"typeId": 0,
"billingRecordId": 0,
"type": "string",
"typeName": "string",
"createInvoice": "yes",
"billingType": 0,
"currencyCode": "string",
"currencyName": "string",
"orderingStatus": "off",
"orderingStatusDt": "2021-06-30T11:16:19.760Z",
"selectedPriceListId": 0,
"ownerId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string",
"description": "string",
"comment": "string",
"invoice": {
"id": 0,
"instanceID": 0,
"custID": 0,
"custName": "string",
"custShortName": "string",
"custAttn": "string",
"custAddress": "string",
"custAddress2": "string",
"custPost": "string",
"custCity": "string",
"custCountry": 0,
"custPOBox": "string",
"custVatNumber": "string",
"invType": 0,
"invTypeName": "string",
"templateID": 0,
"invDate": "string",
"invNumberFix": "string",
"invNumberNum": 0,
"invNumber": "string",
"invPeriod": "string",
"invDueDate": "string",
"overDueDate": 0,
"ownerVatNumber": "string",
"currency": 0,
"currencyCode": "string",
"amountNoVat": 0,
"amountVat": 0,
"vatPercent": 0,
"rounding": 0,
"total": 0,
"totalUnpaid": 0,
"vatInPrice": 0,
"vatInTotal": 0,
"status": "string",
"insertDt": "string",
"statusDt": "string",
"deliveryDate": "string",
"invPeriodStart": "string",
"invPeriodEnd": "string",
"docsDeliveryStatus": "string",
"docsDeliveryStatusDate": "string",
"docsDeliveryDlrStatus": "string",
"docsDeliveryDlrStatusDate": "string",
"selfBilling": "yes",
"totalPaid": 0,
"classCodeName": "string",
"classDomain": "string",
"classArea": "string",
"lang": "string",
"paymentStatus": "none",
"paymentStatusDate": "2021-06-30T11:16:19.762Z",
"disputeStatus": "string",
"disputeStatusDate": "2021-06-30T11:16:19.762Z",
"dataSourceId": 0,
"dataSourceCodeName": "string",
"nettingInvoiceId": 0,
"nettingInvoiceNumber": "string",
"domainId": 0,
"domainCodeName": "string",
"disputeNextId": 0,
"collectionMode": "none",
"collectionLeadId": 0,
"processingStatus": "none",
"dtsSelectorId": 0,
"dtsSelectorCodeName": "string",
"ownerId": 0,
"items": [
{
"id": 0,
"invoiceId": 0,
"ordNum": 0,
"name": "string",
"itemType": "string",
"quantity": 0,
"quantityMore": 0,
"quantityMode": 0,
"measureUnit": 0,
"price": 0,
"vatInPrice": 0,
"totalNoVat": 0,
"totalVat": 0,
"status": "string",
"insertDt": "string",
"statusDt": "string",
"dataSourceId": 0,
"dataSourceForeignKey": 0,
"dtsSelectorId": 0,
"dtsSelectorCodeName": "string"
}
]
}
}
Error Response Unexpected Error: Default
{
"code": 0,
"message": "string",
"description": "string",
"items": [
{
"name": "string",
"message": "string",
"description": "string"
}
]
}