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;
    }
  }
}
customInfo: {
  fra: {
     profileType: string;
  }
}
type Recipient {
  taxId: string;
  address?: Address;
}

type Address {
  country: string;
}

type InvoiceLine {
  description: string;
  price: {
    amount: number;
 };
  quantity: string;
  vat: {
    amount: number;
    code: string;
    type: string;
    exemptReason?: string;
    exemptReasonCode?: string;
  };
}

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;
    code: string;
    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. `B2C transactions must have a placeholder value of nine 0's (000000000)`
`recipient.address.country`	string	Yes	Three-letter country code (ISO 3166-1 alpha-3).
`shipToParty.address.country`	string	Conditional	Country where goods are being shipped to
`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.code`	string	Yes	VAT Code of item
`lines[].vat.exemptReason`	string	Conditional	Required when `vat.amount = 0` Textual reason for exemption
`lines[].vat.exemptReasonCode`	string	Conditional	Required when `vat.amount = 0` Value from an enumerated code list
`lines[].isService`	boolean	Yes	Required for B2C transactions. Indicates whether the line item represents a service. `TRUE= Service` `FALSE= Goods` `An invoice can contain both services and goods`
`customInfo.fra.profileType`	string	Conditional	Required for B2B reporting B1: Filing of a goods invoice; S1: Filing of a service invoice; M1: Filing of a double invoice (delivery of goods and services that are not ancillary); B2: Filing of a goods invoice that has already been paid; S2: Filing of a service invoice that has already been paid; M2: Filing of a double invoice that has already been paid; S3: Filing of a subcontract payment request with direct payment (B2G only, restriction not verifiable); B4: Filing of a final invoice (after advance payment) for goods; S4: Filing of a final invoice (after advance payment) for services; M4: Filing of a final invoice (after advance payment) for double services; S5: Filing of a service invoice by a subcontractor; S6: Filing by a subcontractor of a service invoice B7: Filing of a goods invoice that has been e-reported (VAT already collected) S7: Filing of a service invoice that has been e-reported (VAT already collected) B8: Filing of a multi-vendor goods invoice S8: Filing of a multi-vendor service invoice M8: Filing of a double multi-vendor invoice, containing individual invoices that are not all Sx or Bx. B9: Filing of a bidirectional goods invoice S9: Filing of a bidirectional service invoice M9: Filing of a double bidirectional invoice
`customInfo.fra.transactionType`	string	No	Either B2B or B2C

Lifecycle Status

type LifeCycleStatus {
  status: string;
  issued?: string;
  amount?: number;
  customInfo?:{
    fra?:{
      notes?: string
     }
   }
 }

Field information

Name	Type	Required	Description
`status`	string	Yes	Valid values: `paid`
`issued`	string (ISO 8601 date)	Optional	Date of payment. Will use status update date when not specified.
`amount`	number	Optional	Will use original invoice amount when not specified.
`customInfo.fra.notes`	string	Optional	Any additional comments

Example CSV file

Invoice - fra - B2B e-reporting.csv

Invoice - fra - B2C e-reporting.csv