Get a list of mandates | Solvimon

curl https://test.api.solvimon.com/v1/integrations/e-invoicing/default-mandates \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json"

[
  {
    "name": "EU Standard Mandate",
    "country": "DE",
    "mappings": [
      {
        "target": "Invoice/AccountingSupplierParty/Party/PartyName",
        "source": "supplierName",
        "description": "Maps supplier name to UBL PartyName"
      },
      {
        "target": "Invoice/AccountingCustomerParty/Party/PartyIdentification/ID",
        "source": "customerTaxId",
        "description": "Customer tax identification number"
      }
    ],
    "condition_groups": [
      {
        "conditions": [
          {
            "field": "invoiceTotalAmount",
            "comparator_type": "GREATER_THAN_OR_EQUALS",
            "value": "1000"
          },
          {
            "field": "customerCountry",
            "comparator_type": "EQUALS",
            "value": "DE"
          }
        ]
      }
    ],
    "include_pdf_in_einvoice": true,
    "supported_file_formats": [
      {
        "type": "UBL",
        "description": "Universal Business Language XML format"
      },
      {
        "type": "PDF",
        "description": "PDF copy of the invoice"
      }
    ]
  }
]

Requires the INTEGRATION.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

limitintegerOptional

The amount of records shown in the list

pageintegerOptional

The page which is going to be shown

order_bystringOptional

The parameter by which the response is ordered.

order_directionstringOptional

The order direction by which the response is ordered.

Response

namestring

The name of the mandate

countrystring or nullRead-only

The country that this mandate belongs to

mappingslist of objects or null

The mappings that are used for this Mandate. If not provided, all mappings will be default. If provided, will be merged with defaults

condition_groupslist of objects or null

The condition groups that are used for this mandate. If provided, no defaults will be used. The mandate applies if 1 conditionGroup applies

include_pdf_in_einvoiceboolean or null

Whether the PDF should be included in the submitted eInvoice payload when supported

supported_file_formatslist of objects or nullRead-only

The file formats in which eInvoices for this mandate can be downloaded

Errors

401

Unauthorized Error

403

Forbidden Error

1	[
2	{
3	"name": "EU Standard Mandate",
4	"country": "DE",
5	"mappings": [
6	{
7	"target": "Invoice/AccountingSupplierParty/Party/PartyName",
8	"source": "supplierName",
9	"description": "Maps supplier name to UBL PartyName"
10	},
11	{
12	"target": "Invoice/AccountingCustomerParty/Party/PartyIdentification/ID",
13	"source": "customerTaxId",
14	"description": "Customer tax identification number"
15	}
16	],
17	"condition_groups": [
18	{
19	"conditions": [
20	{
21	"field": "invoiceTotalAmount",
22	"comparator_type": "GREATER_THAN_OR_EQUALS",
23	"value": "1000"
24	},
25	{
26	"field": "customerCountry",
27	"comparator_type": "EQUALS",
28	"value": "DE"
29	}
30	]
31	}
32	],
33	"include_pdf_in_einvoice": true,
34	"supported_file_formats": [
35	{
36	"type": "UBL",
37	"description": "Universal Business Language XML format"
38	},
39	{
40	"type": "PDF",
41	"description": "PDF copy of the invoice"
42	}
43	]
44	}
45	]

Authentication

Path parameters

Headers

Query parameters

Response

Errors