Transaction reporting

B2B

type Invoice {
  id: string;
  created: string;
  modified: string;
  status: InvoiceStatus;
  orgId: string;
  issued: string;
  ref: string;
  recipient?: Recipient;
  total: {
    amount: number;
    currency?: string;
  };
  lines: InvoiceLine[];
  routeRef?: string;
  error?: {
    name: string;
    message: string;
    description?: string;
  };
  type?: InvoiceType;
  shipToParty?: {
    address?: {
     country?: string;
    }
  }
}

type Recipient {
  taxId: string;
  address?: Address;
}

type Address {
  country: string;
}

type InvoiceLine {
  description: string;
  price: {
    amount: number;
 };
  quantity: string;
  vat: {
    amount: number;
    type: string;
    exemptReason?: string;
  };
  isService: boolean;
}

B2C

type Invoice {
  id: string;
  created: string;
  modified: string;
  status: InvoiceStatus;
  orgId: string;
  issued: string;
  ref: string;
  total: {
    amount: number;
    currency: string;
  };
  lines: InvoiceLine[];
  routeRef?: string;
  error?: {
    name: string;
    message: string;
    description?: string;
  };
  type?: InvoiceType;
}

type InvoiceLine {
  price: {
    amount: number;
};
  quantity: string;
  vat: {
    amount: number;
    type: string;
  };
	isService: boolean;
}

Field information

Name	Type	Required	Description
`id`	string (System generated)	Conditional	Unique identifier for the invoice. Required for payment reporting.
`ref`	string	Yes	Sequential number of document
`created`	string (System generated ISO 8601 date)	No	The timestamp when the invoice was created in ISO 8601 format.
`modified`	string (System generated ISO 8601 date)	No	The timestamp when the invoice was last updated in ISO 8601 format.
`status`	string (System generated)	No	A value from an enumerated list of types: pending submission success error
`orgId`	string (System generated)	No	The organisation issuing the invoice. Automatically assigned by the system — present in responses only.
`issued`	string (ISO 8601 date)	Yes	Date of document (issue date)
`recipient.taxId`	string	Yes	TAX identification number.
`recipient.address.country`	string	Yes	Three-letter country code (ISO 3166-1 alpha-3).
`total.amount`	number	Yes	The total amount of the document, including tax charged.
`total.currency`	string	No	Three-letter currency code (ISO 4217-1 alpha-3 ). Defaults to organisation currency.
`lines[].price.amount`	number	Yes	Unit price of the good or service.
`lines[].vat.amount`	number	Yes	VAT percent or value per item.
`lines[].vat.exemptReason`	string	Conditional	Required when `vat.amount = 0` Textual reason for exemption
`lines[].isService`	boolean	Yes	Indicates whether the line item represents a service. `TRUE= Service` `FALSE= Product`

Example CSV file

Invoice - fra - ereporting.csv