abowire
Version:
This is the official **Abowire Javascript SDK**, which makes it easy to connect to the Abowire **GraphQL API** and includes all the required dependencies you need.
914 lines (913 loc) • 38.6 kB
TypeScript
import { CreateCreditNoteInput, GetCreditNoteQueryVariables, ListCreditNotesQueryVariables } from '../../gen/graphql';
import { AbowireGraphQLClient } from '../../graphql/graphql-client';
export declare class CreditNoteApi {
private graphQL;
constructor(graphQL: AbowireGraphQLClient);
create(input: CreateCreditNoteInput): Promise<{
__typename?: "CreditNote" | undefined;
id: string;
number: string;
file: string;
fileFormat: import("../../gen/graphql").InvoiceFormat;
subtotal: number;
total: number;
createdAt?: any;
updatedAt?: any;
metadata?: any;
items: {
__typename?: "CreditNoteItem" | undefined;
description: string;
quantity: number;
unitPrice: number;
price: number;
}[];
taxes?: {
__typename?: "CreditNoteTaxItem" | undefined;
description: string;
rate: number;
amount: number;
}[] | null | undefined;
customer: {
__typename?: "Customer" | undefined;
id: string;
name: string;
paymentMethod?: {
__typename?: "PaymentMethod" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
providerName?: import("../../gen/graphql").PaymentProviderName | null | undefined;
lastDigits?: string | null | undefined;
externalId?: string | null | undefined;
metadata?: any;
} | null | undefined;
};
invoice: {
__typename?: "InvoiceListItem" | undefined;
id: string;
number: string;
currency: any;
locale?: string | null | undefined;
paymentTermDays?: number | null | undefined;
billingPeriodStart: any;
billingPeriodEnd: any;
dueDate: any;
paymentDate?: any;
subtotal: number;
total: number;
metadata?: any;
createdAt?: any;
updatedAt?: any;
seller: {
__typename?: "Billing" | undefined;
companyName?: string | null | undefined;
address: string;
address2?: string | null | undefined;
street?: string | null | undefined;
streetNumber?: string | null | undefined;
postalCode: string;
city: string;
countryCode: string;
invoiceFormat?: import("../../gen/graphql").InvoiceFormat | null | undefined;
metadata?: any;
taxIds?: {
__typename?: "TaxId" | undefined;
type: import("../../gen/graphql").TaxIdType;
countryCode?: string | null | undefined;
value: string;
}[] | null | undefined;
contactPerson?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
phoneNumber?: string | null | undefined;
} | null | undefined;
};
buyer: {
__typename?: "Billing" | undefined;
companyName?: string | null | undefined;
address: string;
address2?: string | null | undefined;
street?: string | null | undefined;
streetNumber?: string | null | undefined;
postalCode: string;
city: string;
countryCode: string;
invoiceFormat?: import("../../gen/graphql").InvoiceFormat | null | undefined;
metadata?: any;
taxIds?: {
__typename?: "TaxId" | undefined;
type: import("../../gen/graphql").TaxIdType;
countryCode?: string | null | undefined;
value: string;
}[] | null | undefined;
contactPerson?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
phoneNumber?: string | null | undefined;
} | null | undefined;
};
customer: {
__typename?: "Customer" | undefined;
id: string;
name: string;
currency?: any;
locale?: string | null | undefined;
metadata?: any;
createdAt?: any;
updatedAt?: any;
billing?: {
__typename?: "Billing" | undefined;
companyName?: string | null | undefined;
address: string;
address2?: string | null | undefined;
street?: string | null | undefined;
streetNumber?: string | null | undefined;
postalCode: string;
city: string;
countryCode: string;
invoiceFormat?: import("../../gen/graphql").InvoiceFormat | null | undefined;
metadata?: any;
taxIds?: {
__typename?: "TaxId" | undefined;
type: import("../../gen/graphql").TaxIdType;
countryCode?: string | null | undefined;
value: string;
}[] | null | undefined;
contactPerson?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
phoneNumber?: string | null | undefined;
} | null | undefined;
} | null | undefined;
people?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
metadata?: any;
settings?: {
__typename?: "PersonSettings" | undefined;
email?: {
__typename?: "PersonEmailSettings" | undefined;
invoices?: boolean | null | undefined;
payments?: boolean | null | undefined;
} | null | undefined;
customerPortal?: {
__typename?: "PersonCustomerPortalSettings" | undefined;
isActive?: boolean | null | undefined;
} | null | undefined;
} | null | undefined;
}[] | null | undefined;
paymentMethod?: {
__typename?: "PaymentMethod" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
providerName?: import("../../gen/graphql").PaymentProviderName | null | undefined;
lastDigits?: string | null | undefined;
externalId?: string | null | undefined;
metadata?: any;
} | null | undefined;
capabilities?: {
__typename?: "ProductCapability" | undefined;
name: string;
isActive: boolean;
usageLimit?: ({
__typename?: "SubscriptionUsage" | undefined;
unit: string;
amount: number;
} | null)[] | null | undefined;
}[] | null | undefined;
};
items: {
__typename?: "InvoiceItem" | undefined;
description: string;
price: number;
}[];
discount?: {
__typename?: "InvoiceDiscount" | undefined;
description: string;
amount: number;
} | null | undefined;
taxes?: {
__typename?: "InvoiceTaxItem" | undefined;
description: string;
amount: number;
rate: number;
}[] | null | undefined;
creditNotes: {
__typename?: "CreditNoteList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "CreditNoteListItem" | undefined;
id: string;
number: string;
total: number;
createdAt?: any;
invoice: {
__typename?: "InvoiceListItem" | undefined;
id: string;
number: string;
currency: any;
};
transactions: {
__typename?: "TransactionList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "Transaction" | undefined;
id: string;
type: import("../../gen/graphql").TransactionType;
amount: number;
}[];
};
}[];
};
transactions: {
__typename?: "TransactionList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "Transaction" | undefined;
id: string;
type: import("../../gen/graphql").TransactionType;
amount: number;
currency: any;
reference?: string | null | undefined;
metadata?: any;
createdAt: any;
updatedAt?: any;
paymentMethod: {
__typename?: "PaymentMethod" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
metadata?: any;
};
customer: {
__typename?: "Customer" | undefined;
id: string;
name: string;
};
invoice?: {
__typename?: "Invoice" | undefined;
id: string;
number: string;
} | null | undefined;
}[];
};
subscription?: {
__typename?: "Subscription" | undefined;
id: string;
isActive: boolean;
product: {
__typename?: "Product" | undefined;
id: string;
name: string;
};
} | null | undefined;
};
transactions: {
__typename?: "TransactionList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "Transaction" | undefined;
id: string;
type: import("../../gen/graphql").TransactionType;
amount: number;
currency: any;
reference?: string | null | undefined;
metadata?: any;
createdAt: any;
updatedAt?: any;
paymentMethod: {
__typename?: "PaymentMethod" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
metadata?: any;
};
customer: {
__typename?: "Customer" | undefined;
id: string;
name: string;
};
creditNote?: {
__typename?: "CreditNote" | undefined;
id: string;
number: string;
} | null | undefined;
}[];
};
}>;
get(id: string, input?: Partial<GetCreditNoteQueryVariables>): Promise<{
__typename?: "CreditNote" | undefined;
id: string;
number: string;
file: string;
fileFormat: import("../../gen/graphql").InvoiceFormat;
subtotal: number;
total: number;
createdAt?: any;
updatedAt?: any;
metadata?: any;
items: {
__typename?: "CreditNoteItem" | undefined;
description: string;
quantity: number;
unitPrice: number;
price: number;
}[];
taxes?: {
__typename?: "CreditNoteTaxItem" | undefined;
description: string;
rate: number;
amount: number;
}[] | null | undefined;
customer: {
__typename?: "Customer" | undefined;
id: string;
name: string;
paymentMethod?: {
__typename?: "PaymentMethod" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
providerName?: import("../../gen/graphql").PaymentProviderName | null | undefined;
lastDigits?: string | null | undefined;
externalId?: string | null | undefined;
metadata?: any;
} | null | undefined;
};
invoice: {
__typename?: "InvoiceListItem" | undefined;
id: string;
number: string;
currency: any;
locale?: string | null | undefined;
paymentTermDays?: number | null | undefined;
billingPeriodStart: any;
billingPeriodEnd: any;
dueDate: any;
paymentDate?: any;
subtotal: number;
total: number;
metadata?: any;
createdAt?: any;
updatedAt?: any;
seller: {
__typename?: "Billing" | undefined;
companyName?: string | null | undefined;
address: string;
address2?: string | null | undefined;
street?: string | null | undefined;
streetNumber?: string | null | undefined;
postalCode: string;
city: string;
countryCode: string;
invoiceFormat?: import("../../gen/graphql").InvoiceFormat | null | undefined;
metadata?: any;
taxIds?: {
__typename?: "TaxId" | undefined;
type: import("../../gen/graphql").TaxIdType;
countryCode?: string | null | undefined;
value: string;
}[] | null | undefined;
contactPerson?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
phoneNumber?: string | null | undefined;
} | null | undefined;
};
buyer: {
__typename?: "Billing" | undefined;
companyName?: string | null | undefined;
address: string;
address2?: string | null | undefined;
street?: string | null | undefined;
streetNumber?: string | null | undefined;
postalCode: string;
city: string;
countryCode: string;
invoiceFormat?: import("../../gen/graphql").InvoiceFormat | null | undefined;
metadata?: any;
taxIds?: {
__typename?: "TaxId" | undefined;
type: import("../../gen/graphql").TaxIdType;
countryCode?: string | null | undefined;
value: string;
}[] | null | undefined;
contactPerson?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
phoneNumber?: string | null | undefined;
} | null | undefined;
};
customer: {
__typename?: "Customer" | undefined;
id: string;
name: string;
currency?: any;
locale?: string | null | undefined;
metadata?: any;
createdAt?: any;
updatedAt?: any;
billing?: {
__typename?: "Billing" | undefined;
companyName?: string | null | undefined;
address: string;
address2?: string | null | undefined;
street?: string | null | undefined;
streetNumber?: string | null | undefined;
postalCode: string;
city: string;
countryCode: string;
invoiceFormat?: import("../../gen/graphql").InvoiceFormat | null | undefined;
metadata?: any;
taxIds?: {
__typename?: "TaxId" | undefined;
type: import("../../gen/graphql").TaxIdType;
countryCode?: string | null | undefined;
value: string;
}[] | null | undefined;
contactPerson?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
phoneNumber?: string | null | undefined;
} | null | undefined;
} | null | undefined;
people?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
metadata?: any;
settings?: {
__typename?: "PersonSettings" | undefined;
email?: {
__typename?: "PersonEmailSettings" | undefined;
invoices?: boolean | null | undefined;
payments?: boolean | null | undefined;
} | null | undefined;
customerPortal?: {
__typename?: "PersonCustomerPortalSettings" | undefined;
isActive?: boolean | null | undefined;
} | null | undefined;
} | null | undefined;
}[] | null | undefined;
paymentMethod?: {
__typename?: "PaymentMethod" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
providerName?: import("../../gen/graphql").PaymentProviderName | null | undefined;
lastDigits?: string | null | undefined;
externalId?: string | null | undefined;
metadata?: any;
} | null | undefined;
capabilities?: {
__typename?: "ProductCapability" | undefined;
name: string;
isActive: boolean;
usageLimit?: ({
__typename?: "SubscriptionUsage" | undefined;
unit: string;
amount: number;
} | null)[] | null | undefined;
}[] | null | undefined;
};
items: {
__typename?: "InvoiceItem" | undefined;
description: string;
price: number;
}[];
discount?: {
__typename?: "InvoiceDiscount" | undefined;
description: string;
amount: number;
} | null | undefined;
taxes?: {
__typename?: "InvoiceTaxItem" | undefined;
description: string;
amount: number;
rate: number;
}[] | null | undefined;
creditNotes: {
__typename?: "CreditNoteList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "CreditNoteListItem" | undefined;
id: string;
number: string;
total: number;
createdAt?: any;
invoice: {
__typename?: "InvoiceListItem" | undefined;
id: string;
number: string;
currency: any;
};
transactions: {
__typename?: "TransactionList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "Transaction" | undefined;
id: string;
type: import("../../gen/graphql").TransactionType;
amount: number;
}[];
};
}[];
};
transactions: {
__typename?: "TransactionList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "Transaction" | undefined;
id: string;
type: import("../../gen/graphql").TransactionType;
amount: number;
currency: any;
reference?: string | null | undefined;
metadata?: any;
createdAt: any;
updatedAt?: any;
paymentMethod: {
__typename?: "PaymentMethod" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
metadata?: any;
};
customer: {
__typename?: "Customer" | undefined;
id: string;
name: string;
};
invoice?: {
__typename?: "Invoice" | undefined;
id: string;
number: string;
} | null | undefined;
}[];
};
subscription?: {
__typename?: "Subscription" | undefined;
id: string;
isActive: boolean;
product: {
__typename?: "Product" | undefined;
id: string;
name: string;
};
} | null | undefined;
};
transactions: {
__typename?: "TransactionList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "Transaction" | undefined;
id: string;
type: import("../../gen/graphql").TransactionType;
amount: number;
currency: any;
reference?: string | null | undefined;
metadata?: any;
createdAt: any;
updatedAt?: any;
paymentMethod: {
__typename?: "PaymentMethod" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
metadata?: any;
};
customer: {
__typename?: "Customer" | undefined;
id: string;
name: string;
};
creditNote?: {
__typename?: "CreditNote" | undefined;
id: string;
number: string;
} | null | undefined;
}[];
};
}>;
list(input?: Partial<ListCreditNotesQueryVariables>): Promise<{
__typename?: "CreditNoteList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "CreditNoteListItem" | undefined;
id: string;
number: string;
subtotal: number;
total: number;
createdAt?: any;
updatedAt?: any;
metadata?: any;
items: {
__typename?: "CreditNoteItem" | undefined;
description: string;
quantity: number;
unitPrice: number;
price: number;
}[];
taxes?: {
__typename?: "CreditNoteTaxItem" | undefined;
description: string;
rate: number;
amount: number;
}[] | null | undefined;
customer: {
__typename?: "Customer" | undefined;
id: string;
name: string;
paymentMethod?: {
__typename?: "PaymentMethod" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
providerName?: import("../../gen/graphql").PaymentProviderName | null | undefined;
lastDigits?: string | null | undefined;
externalId?: string | null | undefined;
metadata?: any;
} | null | undefined;
};
invoice: {
__typename?: "InvoiceListItem" | undefined;
id: string;
number: string;
currency: any;
locale?: string | null | undefined;
paymentTermDays?: number | null | undefined;
billingPeriodStart: any;
billingPeriodEnd: any;
dueDate: any;
paymentDate?: any;
subtotal: number;
total: number;
metadata?: any;
createdAt?: any;
updatedAt?: any;
seller: {
__typename?: "Billing" | undefined;
companyName?: string | null | undefined;
address: string;
address2?: string | null | undefined;
street?: string | null | undefined;
streetNumber?: string | null | undefined;
postalCode: string;
city: string;
countryCode: string;
invoiceFormat?: import("../../gen/graphql").InvoiceFormat | null | undefined;
metadata?: any;
taxIds?: {
__typename?: "TaxId" | undefined;
type: import("../../gen/graphql").TaxIdType;
countryCode?: string | null | undefined;
value: string;
}[] | null | undefined;
contactPerson?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
phoneNumber?: string | null | undefined;
} | null | undefined;
};
buyer: {
__typename?: "Billing" | undefined;
companyName?: string | null | undefined;
address: string;
address2?: string | null | undefined;
street?: string | null | undefined;
streetNumber?: string | null | undefined;
postalCode: string;
city: string;
countryCode: string;
invoiceFormat?: import("../../gen/graphql").InvoiceFormat | null | undefined;
metadata?: any;
taxIds?: {
__typename?: "TaxId" | undefined;
type: import("../../gen/graphql").TaxIdType;
countryCode?: string | null | undefined;
value: string;
}[] | null | undefined;
contactPerson?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
phoneNumber?: string | null | undefined;
} | null | undefined;
};
customer: {
__typename?: "Customer" | undefined;
id: string;
name: string;
currency?: any;
locale?: string | null | undefined;
metadata?: any;
createdAt?: any;
updatedAt?: any;
billing?: {
__typename?: "Billing" | undefined;
companyName?: string | null | undefined;
address: string;
address2?: string | null | undefined;
street?: string | null | undefined;
streetNumber?: string | null | undefined;
postalCode: string;
city: string;
countryCode: string;
invoiceFormat?: import("../../gen/graphql").InvoiceFormat | null | undefined;
metadata?: any;
taxIds?: {
__typename?: "TaxId" | undefined;
type: import("../../gen/graphql").TaxIdType;
countryCode?: string | null | undefined;
value: string;
}[] | null | undefined;
contactPerson?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
phoneNumber?: string | null | undefined;
} | null | undefined;
} | null | undefined;
people?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
metadata?: any;
settings?: {
__typename?: "PersonSettings" | undefined;
email?: {
__typename?: "PersonEmailSettings" | undefined;
invoices?: boolean | null | undefined;
payments?: boolean | null | undefined;
} | null | undefined;
customerPortal?: {
__typename?: "PersonCustomerPortalSettings" | undefined;
isActive?: boolean | null | undefined;
} | null | undefined;
} | null | undefined;
}[] | null | undefined;
paymentMethod?: {
__typename?: "PaymentMethod" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
providerName?: import("../../gen/graphql").PaymentProviderName | null | undefined;
lastDigits?: string | null | undefined;
externalId?: string | null | undefined;
metadata?: any;
} | null | undefined;
capabilities?: {
__typename?: "ProductCapability" | undefined;
name: string;
isActive: boolean;
usageLimit?: ({
__typename?: "SubscriptionUsage" | undefined;
unit: string;
amount: number;
} | null)[] | null | undefined;
}[] | null | undefined;
};
items: {
__typename?: "InvoiceItem" | undefined;
description: string;
price: number;
}[];
discount?: {
__typename?: "InvoiceDiscount" | undefined;
description: string;
amount: number;
} | null | undefined;
taxes?: {
__typename?: "InvoiceTaxItem" | undefined;
description: string;
amount: number;
rate: number;
}[] | null | undefined;
creditNotes: {
__typename?: "CreditNoteList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "CreditNoteListItem" | undefined;
id: string;
number: string;
total: number;
createdAt?: any;
invoice: {
__typename?: "InvoiceListItem" | undefined;
id: string;
number: string;
currency: any;
};
transactions: {
__typename?: "TransactionList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "Transaction" | undefined;
id: string;
type: import("../../gen/graphql").TransactionType;
amount: number;
}[];
};
}[];
};
transactions: {
__typename?: "TransactionList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "Transaction" | undefined;
id: string;
type: import("../../gen/graphql").TransactionType;
amount: number;
currency: any;
reference?: string | null | undefined;
metadata?: any;
createdAt: any;
updatedAt?: any;
paymentMethod: {
__typename?: "PaymentMethod" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
metadata?: any;
};
customer: {
__typename?: "Customer" | undefined;
id: string;
name: string;
};
invoice?: {
__typename?: "Invoice" | undefined;
id: string;
number: string;
} | null | undefined;
}[];
};
subscription?: {
__typename?: "Subscription" | undefined;
id: string;
isActive: boolean;
product: {
__typename?: "Product" | undefined;
id: string;
name: string;
};
} | null | undefined;
};
transactions: {
__typename?: "TransactionList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "Transaction" | undefined;
id: string;
type: import("../../gen/graphql").TransactionType;
amount: number;
currency: any;
reference?: string | null | undefined;
metadata?: any;
createdAt: any;
updatedAt?: any;
paymentMethod: {
__typename?: "PaymentMethod" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
metadata?: any;
};
customer: {
__typename?: "Customer" | undefined;
id: string;
name: string;
};
creditNote?: {
__typename?: "CreditNote" | undefined;
id: string;
number: string;
} | null | undefined;
}[];
};
}[];
}>;
}