Bills
Get all bills
Returns all bills, optionally filtered by customers, identifiers and other filters. Note this operation uses Pagination.
Request
[PlatformAddress]/api/connector/v1/bills/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. |
| optional, max length 3 months | Interval in which the | |
| optional, max length 3 months | Interval in which the | |
| optional, max length 3 months | Interval in which the | |
| optional, max length 3 months | Interval in which the | |
| optional, max length 3 months | Interval in which the | |
| array of string | optional, max 1000 items | Unique identifiers of the |
| array of string | optional, max 1000 items | Unique identifiers of the |
| required | State the bills should be in. If not specified, | |
| array of Bill correction state | optional | Whether to return regular bills, corrective bills, or both. If |
| required | Limitation on the quantity of data returned. | |
|
|
|
Bill extent
Extent of data to be returned. E.g. it is possible to specify that together with the bills, payments and revenue items should be also returned. Deprecated!
Property | Type | Contract | Description |
---|---|---|---|
|
|
|
|
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Bill | required | The filtered bills. |
| string | optional | Unique identifier of the last and hence oldest bill returned. This can be used in |
Bill
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the bill. |
| string | required | Unique identifier of the |
| string | required | Unique identifier of the account ( |
| array of string | optional | Unique identifiers of the |
| string | optional | Unique identifier of the bill |
| required | Whether the bill is | |
| required | After a bill is closed, the Bill Type is set to | |
| string | optional | Number of the bill. |
| string | optional | Variable symbol of the bill. |
| string | required | Date and time of the bill creation in UTC timezone in ISO 8601 format. |
| string | optional | Date and time of the bill issuance in UTC timezone in ISO 8601 format. |
| string | optional | Taxation date of the bill in UTC timezone in ISO 8601 format. |
| string | optional | Date when the bill was paid in UTC timezone in ISO 8601 format. |
| string | optional | Bill due date and time in UTC timezone in ISO 8601 format. |
| string | required | Date and time when the bill was last updated, in UTC timezone in ISO 8601 format. |
| string | optional | Unique number of the purchase order from the buyer. |
| string | optional | Additional notes. |
| optional | Options of the bill. | |
| required | ||
| array of Associated account bill data | optional | Additional information about the associated account of the bill. Can be a |
| optional | Additional information about the enterprise issuing the bill, including bank account details. Persisted at the time of closing of the bill. | |
| required | Whether the bill is a regular bill or a corrective bill. | |
| optional | Type of correction. | |
| string | optional | The ID of the bill that the corrective bill corrects. If the corrected bill was deleted, this field is |
|
|
|
|
|
|
|
|
|
|
| Deprecated! Use |
|
|
| Deprecated! Use |
|
|
|
|
|
|
|
|
|
| Deprecated! Use | |
|
|
|
Bill state
Open
Closed
Bill type
Receipt
- Default; the bill has been paid in full; only applicable after the bill is closed.Invoice
- Bill has not been paid in full but an invoice has been issued to request payment.
Bill options
Options of the bill.
Property | Type | Contract | Description |
---|---|---|---|
| boolean | required | Display customer information on a bill. |
| boolean | required | Display taxation detail on a bill. |
| boolean | required | Tracking of payments is enabled for bill, only applicable for |
| boolean | required | Display CID number on bill, only applicable for |
| boolean | required | Whether the bill is rebated (both fully or partially). |
Bill assignee data
Property | Type | Contract | Description |
---|---|---|---|
| required | Determines type of value. | |
| object | required | Structure of object depends on |
Bill associated account data discriminator
BillCustomerData
BillCompanyData
Bill company data
Property | Type | Contract | Description |
---|---|---|---|
| string | optional | ID of the |
| optional | Address of the company. | |
| object | optional | The set of |
| string | optional | A unique code for Mews to list on invoices it sends to the company. |
| string | required | Name of the company. |
| string | optional | Fiscal identifier of the company. |
| string | optional | Additional tax identifier of the company. |
Bill customer data
Property | Type | Contract | Description |
---|---|---|---|
| string | required | ID of the |
| optional | Address of the customer. | |
| object | optional | The set of |
| string | optional | A unique code for Mews to list on invoices it sends to the customer. |
| string | required | Last name of the customer. |
| string | optional | First name of the customer. |
| string | optional | Second last name of the customer. |
| required | Title prefix of the customer. |
Bill owner data
Additional information about owner of the bill. Can be a Customer or Company. Persisted at the time of closing of the bill.
Property | Type | Contract | Description |
---|---|---|---|
| required | Determines type of value. | |
| object | required | Structure of object depends on |
Associated account bill data
Property | Type | Contract | Description |
---|---|---|---|
| required | Determines type of value. | |
| optional | Associated account bill data for customer. | |
| optional | Associated account bill data for company. |
Bill enterprise data
Additional information about the enterprise issuing the bill, including bank account details. Persisted at the time of closing of the bill.
Property | Type | Contract | Description |
---|---|---|---|
| string | optional | Enterprise additional tax identifier. |
| string | optional | Enterprise company name. |
| string | optional | Enterprise bank account. |
| string | optional | Enterprise bank name. |
| string | optional | Enterprise IBAN (International Bank Account Number). |
| string | optional | Enterprise BIC (Bank Identifier Code). |
Bill correction state
Bill
- Regular bill.CorrectiveBill
- Corrective bill, i.e. theCorrectionType
is eitherEdit
,Cancellation
, orReceivablePaymentsBalance
.
Bill correction type
Cancellation
Edit
CreditNote
Reinstatement
ReceivablePaymentsBalance
Get bill PDF
Creates a PDF version of the specified bill. In case it's not possible to return PDF immediately, you must retry the call later while providing the unique event identifier that is returned from the first invocation.
Request
[PlatformAddress]/api/connector/v1/bills/getPdf
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | required | Unique identifier of the Bill to be printed. |
| string | optional | Unique identifier of the Bill print event returned by previous invocation. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the printed bill. |
| required |
Bill PDF result discriminator
Property | Type | Contract | Description |
---|---|---|---|
| required | Determines type of value. | |
| object | required | Structure of object depends on |
Bill PDF result discriminator
BillPdfFile
- PDF version of aBill
was successfully created,Value
isBillPdfFile
.BillPrintEvent
- PDF version of aBill
couldn't be created at this moment (for example bill haven't been reported to authorities yet),Value
isBillPrintEvent
Bill PDF file
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Base64 encoded PDF file. |
Bill print event
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of print event. Must be used in retry calls to retrieve the PDF. |
Add bill
Creates new empty bill assigned to specified account. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/bills/add
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise. |
| array of Bill parameters | required, max 1000 items | Information about bills to be created. |
Bill parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the account ( |
| string | optional | Account that has a possible link with the owner of the bill. |
| string | optional | Name of the newly created bill. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Bill | required | The created bills. |
Delete bill
Removes selected bills. Bill must be empty, otherwise it's not possible to delete it. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/bills/delete
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise. |
| array of string | required, max 1000 items | Unique identifiers of the Bills to be deleted. |
Response
Close bill
Closes a bill so no further modification to it is possible. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/bills/close
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise. |
| string | required | Unique identifier of the Bill to be closed. |
| required | After a bill is closed, the Bill Type is set to | |
| string | optional | Unique identifier of the Counter to be used for closing. Default one is used when no value is provided. |
| string | optional | Unique identifier of the Fiscal Machine to be used for closing. Default one is used when no value is provided. |
| optional | Options of the bill. If not provided, both DisplayCustomer and DisplayTaxation are set by default. | |
| optional | Date of consumption for tax purposes. Can be used only with | |
| optional | Deadline when bill is due to be paid. Can be used only with | |
| optional | Optional unique identifier of requested payment. Can be used only with | |
| optional | Tax identifier of account to be put on a bill. | |
| optional | Unique number of the purchase order from the buyer. | |
| optional | Notes to be attached to bill. | |
| optional | Address of the account to be displayed on bill. Overrides the default one taken from account profile. | |
| array of Bill close account parameters | optional, max 1 item | Account data of the associated account on a bill. Currently one object is supported and only populated when the bill is closed. |
|
|
| |
|
|
| |
|
|
|
Bill options parameters
Property | Type | Contract | Description |
---|---|---|---|
| required | Display customer information on a bill. | |
| required | Display taxation detail on a bill. |
Bill close account parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the associated account ( |
| optional | Tax identifier of the associated account to be put on a bill. | |
| optional | Address of the associated account to be displayed on bill. Overrides the default one taken from account profile. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Bill | required | The closed bills. |
Last updated