FinOpenPOS
API ReferenceInterfaces

InvoiceBuildData

@finopenpos/fiscal / InvoiceBuildData

Defined in: types.ts:170

Data needed to build an invoice XML

Properties

additionalInfo?

optional additionalInfo: {
  contributorObs?: {
     field: string;
     text: string;
  }[];
  fiscalObs?: {
     field: string;
     text: string;
  }[];
  processRefs?: {
     number: string;
     origin: string;
  }[];
  taxAuthorityNote?: string;
  taxpayerNote?: string;
};

Defined in: types.ts:412

contributorObs?

optional contributorObs: {
  field: string;
  text: string;
}[];

fiscalObs?

optional fiscalObs: {
  field: string;
  text: string;
}[];

processRefs?

optional processRefs: {
  number: string;
  origin: string;
}[];

taxAuthorityNote?

optional taxAuthorityNote: string;

taxpayerNote?

optional taxpayerNote: string;

authorizedXml?

optional authorizedXml: {
  taxId: string;
}[];

Defined in: types.ts:410

taxId

taxId: string;

billing?

optional billing: {
  installments?: {
     dueDate: string;
     number: string;
     value: number;
  }[];
  invoice?: {
     discountValue?: number;
     netValue: number;
     number: string;
     originalValue: number;
  };
};

Defined in: types.ts:341

installments?

optional installments: {
  dueDate: string;
  number: string;
  value: number;
}[];

invoice?

optional invoice: {
  discountValue?: number;
  netValue: number;
  number: string;
  originalValue: number;
};
invoice.discountValue?
optional discountValue: number;
invoice.netValue
netValue: number;
invoice.number
number: string;
invoice.originalValue
originalValue: number;

buyerPresence?

optional buyerPresence: string;

Defined in: types.ts:277


changeAmount?

optional changeAmount: number;

Defined in: types.ts:244


consumerType?

optional consumerType: string;

Defined in: types.ts:275


contingency?

optional contingency: {
  at: Date;
  reason: string;
  type: ContingencyType;
};

Defined in: types.ts:257

at

at: Date;

reason

reason: string;

type

type: ContingencyType;

delivery?

optional delivery: {
  cityCode: string;
  cityName: string;
  complement?: string;
  district: string;
  name?: string;
  number: string;
  stateCode: string;
  street: string;
  taxId: string;
  zipCode?: string;
};

Defined in: types.ts:387

cityCode

cityCode: string;

cityName

cityName: string;

complement?

optional complement: string;

district

district: string;

name?

optional name: string;

number

number: string;

stateCode

stateCode: string;

street

street: string;

taxId

taxId: string;

zipCode?

optional zipCode: string;

emissionProcess?

optional emissionProcess: string;

Defined in: types.ts:273


emissionType

emissionType: EmissionType;

Defined in: types.ts:178


environment

environment: SefazEnvironment;

Defined in: types.ts:180


export?

optional export: {
  dispatchLocation?: string;
  exitState: string;
  exportLocation: string;
};

Defined in: types.ts:454

dispatchLocation?

optional dispatchLocation: string;

exitState

exitState: string;

exportLocation

exportLocation: string;

intermediary?

optional intermediary: {
  idCadIntTran?: string;
  taxId: string;
};

Defined in: types.ts:425

idCadIntTran?

optional idCadIntTran: string;

taxId

taxId: string;

intermediaryIndicator?

optional intermediaryIndicator: string;

Defined in: types.ts:271


issuedAt

issuedAt: Date;

Defined in: types.ts:182


issuer

issuer: {
  addressComplement: string | null;
  cityCode: string;
  cityName: string;
  companyName: string;
  district: string;
  stateCode: string;
  stateTaxId: string;
  street: string;
  streetNumber: string;
  taxId: string;
  taxRegime: TaxRegime;
  tradeName: string | null;
  zipCode: string;
};

Defined in: types.ts:186

addressComplement

addressComplement: string | null;

cityCode

cityCode: string;

cityName

cityName: string;

companyName

companyName: string;

district

district: string;

stateCode

stateCode: string;

stateTaxId

stateTaxId: string;

street

street: string;

streetNumber

streetNumber: string;

taxId

taxId: string;

taxRegime

taxRegime: TaxRegime;

tradeName

tradeName: string | null;

zipCode

zipCode: string;

items

items: InvoiceItemData[];

Defined in: types.ts:240


model

model: InvoiceModel;

Defined in: types.ts:172


number

number: number;

Defined in: types.ts:176


operationNature

operationNature: string;

Defined in: types.ts:184


operationType?

optional operationType: number;

Defined in: types.ts:267


paymentCardDetails?

optional paymentCardDetails: {
  authCode?: string;
  cardBrand?: string;
  cardTaxId?: string;
  integType?: string;
}[];

Defined in: types.ts:246

authCode?

optional authCode: string;

cardBrand?

optional cardBrand: string;

cardTaxId?

optional cardTaxId: string;

integType?

optional integType: string;

payments

payments: PaymentData[];

Defined in: types.ts:242


printFormat?

optional printFormat: string;

Defined in: types.ts:279


purchase?

optional purchase: {
  contractNumber?: string;
  orderNumber?: string;
  purchaseNote?: string;
};

Defined in: types.ts:445

contractNumber?

optional contractNumber: string;

orderNumber?

optional orderNumber: string;

purchaseNote?

optional purchaseNote: string;

purposeCode?

optional purposeCode: number;

Defined in: types.ts:269


recipient?

optional recipient: {
  cityCode?: string;
  cityName?: string;
  complement?: string;
  district?: string;
  name: string;
  stateCode?: string;
  stateTaxId?: string;
  street?: string;
  streetNumber?: string;
  taxId: string;
  zipCode?: string;
};

Defined in: types.ts:215

cityCode?

optional cityCode: string;

cityName?

optional cityName: string;

complement?

optional complement: string;

district?

optional district: string;

name

name: string;

stateCode?

optional stateCode: string;

stateTaxId?

optional stateTaxId: string;

street?

optional street: string;

streetNumber?

optional streetNumber: string;

taxId

taxId: string;

zipCode?

optional zipCode: string;

references?

optional references: (
  | {
  accessKey: string;
  type: "nfe";
}
  | {
  model: string;
  number: string;
  series: string;
  stateCode: string;
  taxId: string;
  type: "nf";
  yearMonth: string;
}
  | {
  model: string;
  number: string;
  series: string;
  stateCode: string;
  taxId: string;
  type: "nfp";
  yearMonth: string;
}
  | {
  accessKey: string;
  type: "cte";
}
  | {
  cooNumber: string;
  ecfNumber: string;
  model: string;
  type: "ecf";
})[];

Defined in: types.ts:281


retTrib?

optional retTrib: RetTribData;

Defined in: types.ts:432


series

series: number;

Defined in: types.ts:174


techResponsible?

optional techResponsible: {
  contact: string;
  email: string;
  phone?: string;
  taxId: string;
};

Defined in: types.ts:434

contact

contact: string;

email

email: string;

phone?

optional phone: string;

taxId

taxId: string;

transport?

optional transport: {
  carrier?: {
     address?: string;
     name?: string;
     stateCode?: string;
     stateTaxId?: string;
     taxId?: string;
  };
  freightMode: string;
  retainedIcms?: {
     cfop: string;
     cityCode: string;
     pICMSRet: number;
     vBCRet: number;
     vICMSRet: number;
  };
  trailers?: {
     plate: string;
     rntc?: string;
     stateCode: string;
  }[];
  vehicle?: {
     plate: string;
     rntc?: string;
     stateCode: string;
  };
  volumes?: {
     brand?: string;
     grossWeight?: number;
     netWeight?: number;
     number?: string;
     quantity?: number;
     seals?: string[];
     species?: string;
  }[];
};

Defined in: types.ts:289

carrier?

optional carrier: {
  address?: string;
  name?: string;
  stateCode?: string;
  stateTaxId?: string;
  taxId?: string;
};
carrier.address?
optional address: string;
carrier.name?
optional name: string;
carrier.stateCode?
optional stateCode: string;
carrier.stateTaxId?
optional stateTaxId: string;
carrier.taxId?
optional taxId: string;

freightMode

freightMode: string;

retainedIcms?

optional retainedIcms: {
  cfop: string;
  cityCode: string;
  pICMSRet: number;
  vBCRet: number;
  vICMSRet: number;
};
retainedIcms.cfop
cfop: string;
retainedIcms.cityCode
cityCode: string;
retainedIcms.pICMSRet
pICMSRet: number;
retainedIcms.vBCRet
vBCRet: number;
retainedIcms.vICMSRet
vICMSRet: number;

trailers?

optional trailers: {
  plate: string;
  rntc?: string;
  stateCode: string;
}[];

vehicle?

optional vehicle: {
  plate: string;
  rntc?: string;
  stateCode: string;
};
vehicle.plate
plate: string;
vehicle.rntc?
optional rntc: string;
vehicle.stateCode
stateCode: string;

volumes?

optional volumes: {
  brand?: string;
  grossWeight?: number;
  netWeight?: number;
  number?: string;
  quantity?: number;
  seals?: string[];
  species?: string;
}[];

withdrawal?

optional withdrawal: {
  cityCode: string;
  cityName: string;
  complement?: string;
  district: string;
  name?: string;
  number: string;
  stateCode: string;
  street: string;
  taxId: string;
  zipCode?: string;
};

Defined in: types.ts:364

cityCode

cityCode: string;

cityName

cityName: string;

complement?

optional complement: string;

district

district: string;

name?

optional name: string;

number

number: string;

stateCode

stateCode: string;

street

street: string;

taxId

taxId: string;

zipCode?

optional zipCode: string;

On this page