bulkImportInvoices

Requires at least one of the permissions payments:invoice:import or purchase:purchase_invoice:import.

Imports many invoices from a file in one call. The result reports how many rows succeeded and failed and lists the errors, so you can correct and resubmit the failed rows. Needs the invoice import permission for sales invoices, or the purchase invoices import permission for purchase invoices.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation BulkImportInvoices($input: BulkImportInvoicesInput!) {
  bulkImportInvoices(input: $input) {
    failed
    success
    errors {
      invoiceNumber
      errors
      row
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation BulkImportInvoices($input: BulkImportInvoicesInput!) {\n  bulkImportInvoices(input: $input) {\n    failed\n    success\n    errors {\n      invoiceNumber\n      errors\n      row\n    }\n  }\n}",
  "variables": {
    "input": {
      "fileContent": "string",
      "format": "CSV",
      "invoiceType": "PURCHASE_INVOICE",
      "updateExisting": true,
      "validateOnly": true
    }
  }
}
EOF

Variables:

{
  "input": {
    "fileContent": "string",
    "format": "CSV",
    "invoiceType": "PURCHASE_INVOICE",
    "updateExisting": true,
    "validateOnly": true
  }
}

Response:

{
  "data": {
    "bulkImportInvoices": {
      "failed": 0,
      "success": 0,
      "errors": [
        {
          "invoiceNumber": "string",
          "errors": [
            "string"
          ],
          "row": 0
        }
      ]
    }
  }
}

bulkImportInvoices(
  input: BulkImportInvoicesInput!
): BulkImportResult!

Arguments

bulkImportInvoices.input ● BulkImportInvoicesInput! non-null input

The import file and options.

Type

BulkImportResult object

The outcome of a bulk invoice import.