List country mandates that are supported by the Avalara E-Invoicing platform

{
  "@recordsetCount": 1,
  "@nextLink": "",
  "value": [
    {
      "mandateId": "AU-B2G-PEPPOL",
      "countryMandate": "AU-B2G-PEPPOL",
      "countryCode": "AU",
      "description": "The mandate supporting B2G eInvoicing in Australia. This function will create a Peppol BIS 3.0 file and sends the invoice to the related recipient via the Peppol network",
      "supportedByELRAPI": "true",
      "mandateFormat": "xml",
      "eInvoicingFlow": "Network",
      "eInvoicingFlowDocumentationLink": "https://documentation.example.com/flows/pt-b2c-pdf",
      "getInvoiceAvailableMediaType": [
        "application/pdf",
        "application/xml"
      ],
      "supportsInboundDigitalDocument": "TRUE",
      "inputDataFormats": [
        {
          "format": "ubl-invoice"
        }
      ],
      "outputDataFormats": [
        {
          "format": "ubl-invoice"
        }
      ],
      "workflowIds": [
        {
          "name": "partner-einvoicing",
          "description": "The standard value for the metadata object in POST /einvoicing/documents "
        }
      ],
      "supportedDocumentStatuses": [
        {
          "status": "Approved",
          "description": "Approved by buyer(C4)"
        },
        {
          "status": "Fully Paid",
          "description": "Payment transmitted to Seller fully from Buyer"
        },
        {
          "status": "Taken Charge",
          "description": "Document has been taken in charge by the recipient (C4)"
        }
      ]
    }
  ]
}

Access control: this endpoint is available to users with the everyone role.

This endpoint offers a list of country mandates supported by the Avalara E-Invoicing API.

Authentication

AuthorizationBearer

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

Query parameters

$filterstringOptionalformat: "string"

Filter by field name and value. This filter only supports eq and contains. Refer to https://developer.avalara.com/avatax/filtering-in-rest/ for more information on filtering.

$topintegerOptional

The number of items to include in the result.

$skipintegerOptional

The number of items to skip in the result.

$countstringOptionalformat: "boolean"

When set to true, the count of the collection is also returned in the response body.

$countOnlystringOptionalformat: "boolean"

When set to true, only the count of the collection is returned.

Response

Returns a MandatesResponse object containing the supported country mandates.

@recordsetCountdoubleOptional

Total count of results

@nextLinkstring or nullOptional

valuelist of objectsOptional

Mandates schema

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Headers

Query parameters

Response

Errors