Add bill
POST /api/connector/v1/bills/add
Creates new empty bill assigned to specified account. Note this operation supports Portfolio Access Tokens.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
Information about bills to be created.
object
Unique identifier of the account (Customer or Company) the bill is issued to. Company billing may not be enabled for your integration.
Account that has a possible link with the owner of the bill.
Name of the newly created bill.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Bills": [ { "AccountId": "a5786a7b-a388-43cc-a838-abd7007b5ff7", "Name": "Bill of Joe Doe" } ]}Responses
Section titled “ Responses ”OK
object
The created bills.
object
Unique identifier of the bill.
Name of the bill.
Unique identifier of the Enterprise.
Unique identifier of the account (Customer or Company) the bill is issued to.
Unique identifier of the Customer the bill is issued to.
Unique identifier of the Company specified in CompanyDetails or the Company the bill is issued to.
Unique identifiers of the Customers or Companies that are associated to the bill.
Unique identifier of the bill Counter.
Whether the bill is Open or Closed.
After a bill is closed, the Bill Type is set to Receipt or Invoice. Receipt indicates that the bill has been fully paid and the balance is zero. Invoice indicates that the bill has not yet been fully paid but an invoice has been issued. Prior to closing, Bill Type should not be used.
Number of the bill.
Variable symbol of the bill.
Date and time of the bill creation in UTC timezone in ISO 8601 format.
Date and time of the bill issuance in UTC timezone in ISO 8601 format.
Taxation date of the bill in UTC timezone in ISO 8601 format.
Date when the bill was paid in UTC timezone in ISO 8601 format.
Bill due date and time in UTC timezone in ISO 8601 format.
Date and time when an email reminder to pay an invoice was last sent, in UTC timezone in ISO 8601 format.
Date and time when the bill was last updated, in UTC timezone in ISO 8601 format.
Unique number of the purchase order from the buyer.
Additional notes.
Options of the bill.
object
Display customer information on a bill.
Display taxation detail on a bill.
Tracking of payments is enabled for bill, only applicable for BillType of Invoice.
Display CID number on bill, only applicable for BillType of Invoice.
Whether the bill is rebated (both fully or partially).
object
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Code of tax exemption reason. Restricted! This property is currently intended for Mews’ internal usage and may be subject to change.
object
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Code of tax exemption reason. Restricted! This property is currently intended for Mews’ internal usage and may be subject to change.
The order items (consumed items such as nights or products) on the bill.
object
Unique identifier of the item.
Unique identifier of the account (for example Customer) the item belongs to.
Unique identifier of the order (or Reservation which is a special type of order) the item belongs to.
Unique identifier of the Bill the item is assigned to.
Unique identifier of the Accounting category the item belongs to.
Unit count of item, i.e. the number of sub-items or units, if applicable.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Revenue type of the item.
Date and time of the item consumption in UTC timezone in ISO 8601 format.
Date and time of the item bill closure in UTC timezone in ISO 8601 format.
Accounting state of the item.
Additional data specific to particular order item.
object
object
object
The payment items (such as cash, credit card payments or invoices) on the bill.
Payment item
object
Unique identifier of the item.
Unique identifier of the account (for example Customer) the item belongs to.
Unique identifier of the Bill the item is assigned to.
Unique identifier of the Accounting category the item belongs to.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Additional notes.
Identifier of the settled payment from the external system (ApplePay/GooglePay).
Date and time of the item consumption in UTC timezone in ISO 8601 format.
Date and time of the item bill closure in UTC timezone in ISO 8601 format.
Accounting state of the item.
Payment state of the item.
Additional data specific to particular payment item.
object
object
object
object
object
ID of the Company.
Address of the company.
object
The set of LegalIdentifiers for the company.
object
A unique code for Mews to list on invoices it sends to the company.
Name of the company.
Fiscal identifier of the company.
Additional tax identifier of the company.
DUNS (Data Universal Numbering System) number of the company.
Company telephone number.
Tax identifier of the company.
Invoicing email of the company.
Department of the company.
object
ID of the Customer to whom the bill was assigned.
Address of the customer.
object
The set of LegalIdentifiers for the customer.
object
A unique code for Mews to list on invoices it sends to the customer.
Last name of the customer.
First name of the customer.
Second last name of the customer.
Title prefix of the customer.
Mister (Mr.)
Miss (Ms.)
Misses (Mrs.)
Tax identifier of the customer.
Additional information about owner of the bill. Can be a Customer or Company. Persisted at the time of closing of the bill.
object
object
ID of the Company.
Address of the company.
object
The set of LegalIdentifiers for the company.
object
A unique code for Mews to list on invoices it sends to the company.
Name of the company.
Fiscal identifier of the company.
Additional tax identifier of the company.
DUNS (Data Universal Numbering System) number of the company.
Company telephone number.
Tax identifier of the company.
Invoicing email of the company.
Department of the company.
object
ID of the Customer to whom the bill was assigned.
Address of the customer.
object
The set of LegalIdentifiers for the customer.
object
A unique code for Mews to list on invoices it sends to the customer.
Last name of the customer.
First name of the customer.
Second last name of the customer.
Title prefix of the customer.
Mister (Mr.)
Miss (Ms.)
Misses (Mrs.)
Tax identifier of the customer.
Additional information about the company assigned to the bill. Not the same as the owner. Persisted at the time of closing of the bill.
object
ID of the Company.
Address of the company.
object
The set of LegalIdentifiers for the company.
object
A unique code for Mews to list on invoices it sends to the company.
Name of the company.
Fiscal identifier of the company.
Additional tax identifier of the company.
DUNS (Data Universal Numbering System) number of the company.
Company telephone number.
Tax identifier of the company.
Invoicing email of the company.
Department of the company.
Additional information about the associated account of the bill. Can be a Customer or Company. Persisted at the time of closing of the bill. Currently only one account can be associated with a bill, but this may be extended in future.
object
Associated account bill data for customer.
object
ID of the Customer to whom the bill was assigned.
Address of the customer.
object
The set of LegalIdentifiers for the customer.
object
A unique code for Mews to list on invoices it sends to the customer.
Last name of the customer.
First name of the customer.
Second last name of the customer.
Title prefix of the customer.
Mister (Mr.)
Miss (Ms.)
Misses (Mrs.)
Tax identifier of the customer.
Associated account bill data for company.
object
ID of the Company.
Address of the company.
object
The set of LegalIdentifiers for the company.
object
A unique code for Mews to list on invoices it sends to the company.
Name of the company.
Fiscal identifier of the company.
Additional tax identifier of the company.
DUNS (Data Universal Numbering System) number of the company.
Company telephone number.
Tax identifier of the company.
Invoicing email of the company.
Department of the company.
Additional information about the enterprise issuing the bill, including bank account details. Persisted at the time of closing of the bill.
object
Enterprise additional tax identifier.
Enterprise company name.
Enterprise bank account.
Enterprise bank name.
Enterprise IBAN (International Bank Account Number).
Enterprise BIC (Bank Identifier Code).
Whether the bill is a regular bill or a corrective bill.
Bill (Regular bill.)
CorrectiveBill (Corrective bill, i.e. the CorrectionType is either Edit, Cancellation, or ReceivablePaymentsBalance.)
Type of correction.
Cancellation
Edit
CreditNote
Reinstatement
ReceivablePaymentsBalance
The ID of the bill that the corrective bill corrects. If the corrected bill was deleted, this field is null.
Example
{ "BillId": "44eba542-193e-47c7-8077-abd7008eb206", "Result": { "Discriminator": "BillPdfFile", "Value": { "Base64Data": "JVBER....." } }}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.